diff options
Diffstat (limited to 'data/zh_cn/clickhouse')
| -rw-r--r-- | data/zh_cn/clickhouse/2019-11-11/api-docs.php | 15835 | ||||
| -rw-r--r-- | data/zh_cn/clickhouse/2023-05-22/api-docs.php | 10393 |
2 files changed, 11700 insertions, 14528 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 index 2fff3e0..a3b1f53 100644 --- a/data/zh_cn/clickhouse/2019-11-11/api-docs.php +++ b/data/zh_cn/clickhouse/2019-11-11/api-docs.php @@ -1,261 +1,164 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'clickhouse', - 'version' => '2019-11-11', - ], + 'info' => ['style' => 'RPC', 'product' => 'clickhouse', 'version' => '2019-11-11'], 'directories' => [ [ - 'id' => 182889, - 'title' => '地域管理', - 'type' => 'directory', - 'children' => [ - 'DescribeRegions', - ], - ], - [ - 'id' => 165004, - 'title' => '集群管理', + 'children' => ['CreatePortsForClickHouse', 'ReleaseClusterPublicConnection', 'AllocateClusterPublicConnection', 'DescribeDBClusterNetInfoItems'], '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' => 34304, ], [ - 'id' => 129255, - 'title' => '账号管理', + 'children' => ['CreateSQLAccount', 'CreateAccountAndAuthority', 'DescribeAccountAuthority', 'ModifyAccountAuthority'], 'type' => 'directory', - 'children' => [ - 'DescribeAccounts', - 'CreateAccount', - 'CreateSQLAccount', - 'DeleteAccount', - 'ResetAccountPassword', - 'ModifyAccountDescription', - 'CreateAccountAndAuthority', - 'DescribeAccountAuthority', - 'ModifyAccountAuthority', - ], + 'title' => '账号管理', + 'id' => 34246, ], [ - 'id' => 182893, - 'title' => '安全管理', + 'children' => ['CreateMonitorDataReport', 'CheckMonitorAlert'], 'type' => 'directory', - 'children' => [ - 'DescribeDBClusterAccessWhiteList', - 'ModifyDBClusterAccessWhiteList', - 'CreateMonitorDataReport', - 'CheckMonitorAlert', - ], + 'title' => '安全管理', + 'id' => 34309, ], [ - 'id' => 186892, - 'title' => '其他', - 'type' => 'directory', 'children' => [ - 'CheckServiceLinkedRole', - 'ModifyMinorVersionGreadeType', + 'ModifyMinorVersionGreadeType', 'CancelActiveOperationTasks', 'CancelAppointmentElectZookeeperLeader', 'CancelAppointmentRestartInstanceNodeList', 'CancelRestartInstance', 'ChangeResourceGroup', 'CheckClickhouseToRDS', 'CheckModifyConfigNeedRestart', 'CheckScaleOutBalanced', 'CheckServiceLinkedRole', 'CreateAccount', 'CreateBackupPolicy', 'CreateDBInstance', 'CreateOSSStorage', 'CreateRDSToClickhouseDb', 'CreateSLB', 'CreateServiceLinkedRole', 'DeleteAccount', 'DeleteBackupPolicy', 'DeleteDBCluster', + 'DeleteSLB', 'DeleteSyndb', 'DescribeAccounts', 'DescribeActiveOperationMaintainConf', 'DescribeActiveOperationTasks', 'DescribeAllDataSource', 'DescribeAllDataSources', 'DescribeAutoRenewAttribute', 'DescribeBackupPolicy', 'DescribeBackups', 'DescribeColumns', 'DescribeConfigHistory', 'DescribeConfigVersionDifference', 'DescribeDBClusterAccessWhiteList', 'DescribeDBClusterAttribute', 'DescribeDBClusterConfig', 'DescribeDBClusterConfigInXML', 'DescribeDBClusterNodeInfos', 'DescribeDBClusterPerformance', 'DescribeDBClusterStatusSet', + 'DescribeDBClusters', 'DescribeDBConfig', 'DescribeEventMetaInfo', 'DescribeOSSStorage', 'DescribeProcessList', 'DescribeRegions', 'DescribeSchemas', 'DescribeSlowLogRecords', 'DescribeSlowLogTrend', 'DescribeSynDbTables', 'DescribeSynDbs', 'DescribeTables', 'DescribeTransferHistory', 'DescribeUserEncryptionKeyList', 'ElectZookeeperLeader', 'KillProcess', 'ListTagResources', 'ModifyAccountDescription', 'ModifyActiveOperationMaintainConf', 'ModifyActiveOperationTasks', + 'ModifyAutoRenewAttribute', 'ModifyBackupPolicy', 'ModifyDBCluster', 'ModifyDBClusterAccessWhiteList', 'ModifyDBClusterConfig', 'ModifyDBClusterConfigInXML', 'ModifyDBClusterDescription', 'ModifyDBClusterMaintainTime', 'ModifyDBConfig', 'ModifyRDSToClickhouseDb', 'ResetAccountPassword', 'RestartInstance', 'RestartInstanceNodeList', 'TagResources', 'TransferVersion', 'UntagResources', 'UpgradeMinorVersion', ], - ], - [ - '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', - ], + 'title' => '其他', + 'id' => 34314, ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'DescribeRegions' => [ - 'summary' => '查询云数据库ClickHouse所有地域和可用区的信息。', - 'methods' => [ - 'post', - 'get', + '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****'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], + ], + 'description' => '', + ], + ], ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '对集群开通公网', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateClusterPublicConnection'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:AllocateClusterPublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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":""}]', + ], + 'CancelActiveOperationTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19455', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '201219', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], + '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' => [ - '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', - ], - ], - ], - ], - ], - ], + 'Ids' => ['description' => '批量取消的运维任务ID，多个 ID 间使用英文逗号（,）分隔。', 'type' => 'string', 'example' => '188****,188****,188****'."\n"], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeRegionsResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n <Regions>\\n <Zones>\\n <ZoneId>cn-hangzhou-h</ZoneId>\\n <VpcEnabled>true</VpcEnabled>\\n </Zones>\\n <RegionId>cn-hangzhou</RegionId>\\n </Regions>\\n</DescribeRegionsResponse>","errorExample":""}]', - 'title' => '查看可选的地域和可用区', - ], - 'CreateDBInstance' => [ - 'summary' => '创建一个云数据库ClickHouse集群。', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '取消尚未开始的运维任务', + 'summary' => '取消运维事件任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"188****,188****,188****\\\\n\\",\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\"\\n}","type":"json"}]', + ], + 'CancelAppointmentElectZookeeperLeader' => [ + 'summary' => '取消预约ClickHouse社区兼容版实例Zookeeper切主', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -264,530 +167,524 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '19424', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], - 'tenantRelevance' => 'publicInformation', + 'chargeType' => 'free', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ZoneId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '可用区ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'DBClusterVersion', + 'name' => 'PageSize', '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', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'DBClusterCategory', + 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '副本配置，取值说明：'."\n" - .'- **Basic**：单副本版。'."\n" - .'- **HighAvailability**：双副本版。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'Basic' => 'Basic', - 'HighAvailability' => 'HighAvailability', + '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'], ], - 'example' => 'Basic', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '取消预约Zookeeper切主', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","type":"json"}]', + ], + 'CancelAppointmentRestartInstanceNodeList' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - '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', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], + ], + 'parameters' => [ [ - 'name' => 'DBNodeGroupCount', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '节点数量。'."\n" - .'- 单副本版，取值范围：1~48。'."\n" - .'- 双副本版，取值范围：1~24。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '实例所属地域的ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBNodeStorage', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '单节点存储空间，取值范围：100 GB~32000 GB。'."\n" - ."\n" - .'>步长为100 GB。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'DBClusterNetworkType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '网络类型，目前只支持VPC。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'VPC', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + '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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '取消预约重启节点列表', + 'summary' => '取消预约重启ClickHouse节点列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","type":"json"}]', + ], + 'CancelRestartInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PayType', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '付费类型，取值说明：'."\n" - .'- **Postpaid**：按量付费。'."\n" - .'- **Prepaid**：预付费（包年包月）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'Prepaid' => 'Prepaid', - 'Postpaid' => 'Postpaid', - ], - 'example' => 'Prepaid', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Period', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '预付费集群为包年或包月类型，取值说明：'."\n" - .'><notice>当付费类型为Prepaid时，该参数才生效且为必填参数。></notice> '."\n" - .'- **Year**：包年。'."\n" - .'- **Month**：包月。', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - ], + 'schema' => ['description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1t9lbb7a4z7****'], ], [ - 'name' => 'UsedTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '预付费集群的购买时长。'."\n" - .'><notice>当付费类型为Prepaid时，该参数才生效且为必填参数。></notice>'."\n" - .'- 当Period为Year时，取值范围：1~3（整数）。'."\n" - .'- 当Period为Month时，取值范围：1~9（整数）。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'VPCId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-bp175iuvg8nxqraf2****', - ], + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'VSwitchId', + 'name' => 'RestartTime', 'in' => 'query', + 'schema' => ['description' => '预约重启的时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-03-22T00:00:50Z'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1gzt31twhlo0sa5****', + '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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'CancelRestartInstance', + 'summary' => '调用CancelRestartInstance接口取消指定云数据库ClickHouse社区兼容版集群的预约重启时间。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:CancelRestartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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":""}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改ClickHouse社区兼容版集群所在资源组。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClientToken', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163948', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', 'in' => 'query', - 'schema' => [ - 'description' => '用于保证请求的幂等性。字符串格式，不超过64个ASCII字符即可。', - 'type' => 'string', - 'required' => false, - 'example' => 'AB', - ], + 'schema' => ['title' => '资源Id', 'description' => '资源Id', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1i43033051****'], ], [ - 'name' => 'DbNodeStorageType', + 'name' => 'ResourceRegionId', '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', - ], + 'schema' => ['title' => '地域Id', 'description' => '地域Id', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'EncryptionKey', + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['title' => '目标资源组', 'description' => '目标资源组', 'type' => 'string', 'required' => true, 'example' => 'rg-4690g37929****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '加密类型为CloudDisk时，该参数为必填参数。'."\n" - ."\n" - .'云盘加密的密钥ID。您可以在密钥管理服务控制台查看密钥ID，也可以创建新的密钥。'."\n" - .'>加密类型为空时，不用填写该参数。', - 'type' => 'string', - 'required' => false, - 'example' => '0d2470df-da7b-4786-b981-9a164dae****', + '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', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', 'description' => ''], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改ClickHouse社区兼容版集群所在资源组', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2\\"\\n}","type":"json"}]', + ], + 'CheckClickhouseToRDS' => [ + 'summary' => '调用CheckClickhouseToRDS接口检查云数据库ClickHouse社区兼容版集群与云数据库RDS MySQL的连通性。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EncryptionType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '43669', + 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], + ], + 'parameters' => [ + [ + 'name' => 'DbClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '加密类型。目前只支持云盘加密，值为**CloudDisk**。'."\n" - .'>不填写该参数时，表示不加密。', - 'type' => 'string', - 'required' => false, - 'example' => 'CloudDisk', - ], + 'schema' => ['description' => '云数据库ClickHouse社区兼容版集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-2zeyy362b5sbm****'], ], [ - 'name' => 'BackupSetID', + 'name' => 'ClickhousePort', 'in' => 'query', - 'schema' => [ - 'description' => '备份集ID。您可以通过调用[DescribeBackups](~~360339~~)接口查询备份集ID。'."\n" - .'>当云数据库ClickHouse集群进行数据恢复时，该参数为必填项。', - 'type' => 'string', - 'required' => false, - 'example' => 'b-12af23adsf', - ], + 'schema' => ['description' => '云数据库ClickHouse端口号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8123'], ], [ - 'name' => 'SourceDBClusterId', + 'name' => 'CkUserName', 'in' => 'query', - 'schema' => [ - 'description' => '源集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询备份集ID。'."\n" - .'>当云数据库ClickHouse集群进行数据恢复时，该参数为必填项。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp1lxbo89u950****', - ], + 'schema' => ['description' => '云数据库ClickHouse的数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'user1'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'CkPassword', 'in' => 'query', - 'schema' => [ - 'description' => '集群所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-4690g37929****', - ], + 'schema' => ['description' => '云数据库ClickHouse的数据库账号密码。', 'type' => 'string', 'required' => true, 'example' => '123456Aa'], ], [ - 'name' => 'ZoneIdBak', + 'name' => 'RdsId', 'in' => 'query', - 'schema' => [ - 'description' => '备可用区。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-k', - ], + 'schema' => ['description' => '云数据库RDS实例ID。', 'type' => 'string', 'required' => true, 'example' => 'rm-bp13v4bnwlu8j****'], ], [ - 'name' => 'VSwitchBak', + 'name' => 'RdsPort', 'in' => 'query', - 'schema' => [ - 'title' => '备专有网络交换机', - 'description' => '备专有网络交换机。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1gzt31twhlo0sa5****', - ], + 'schema' => ['description' => '云数据库RDS端口号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3306'], ], [ - 'name' => 'ZondIdBak2', + 'name' => 'RdsVpcId', 'in' => 'query', - 'schema' => [ - 'description' => '备可用区2。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-j', - ], + 'schema' => ['description' => '云数据库RDS的VPC ID。', 'type' => 'string', 'required' => true, 'example' => 'vpc-wz9mm0qka0winfl47****'], ], [ - 'name' => 'VSwitchBak2', + 'name' => 'RdsUserName', 'in' => 'query', - 'schema' => [ - 'title' => '备专有网络交换机2', - 'description' => '备专有网络交换机2。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp1gzt31twhlo0sa5****', - ], + 'schema' => ['description' => '云数据库RDS的数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'user2'], ], [ - 'name' => 'AutoRenew', + 'name' => 'RdsPassword', 'in' => 'query', - 'schema' => [ - 'description' => '是否开启自动续费。'."\n" - .'>仅在PayType = Prepaid，预付费时生效。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '云数据库RDS的数据库账号密码。', 'type' => 'string', 'required' => true, 'example' => '123456Rr'], ], [ - 'name' => 'Tags', + 'name' => 'RdsVpcUrl', '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, - ], + 'schema' => ['description' => '云数据库RDS的内网地址。', 'type' => 'string', 'required' => true, 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com'], ], ], '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****', - ], + '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'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '检查与RDS连通性', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckClickhouseToRDS'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckClickhouseToRDS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'CheckModifyConfigNeedRestart' => [ + 'summary' => '调用CheckModifyConfigNeedRestart接口查询云数据库ClickHouse社区兼容版集群在XML模式下配置参数的变更是否需要重启。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '19428', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '152285', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '按量付费集群的ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + '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' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', - ], + 'NeedRestart' => ['description' => '变更配置参数后是否重启。取值说明：'."\n" + .'- **true**：重启。'."\n" + .'- **false**：不重启。', 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C'], ], ], ], ], - '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', + 'title' => '查询配置参数是否需要重启', + 'description' => '>该接口仅支持2021年12月01日之后创建的社区兼容版集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckModifyConfigNeedRestart', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'CheckMonitorAlert' => [ + 'summary' => '调用CheckMonitorAlert接口校验指定云数据库ClickHouse集群是否开通了ARMS（Application Real-Time Monitoring Service）服务提供的监控告警功能。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -797,125 +694,119 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '19443', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], + 'abilityTreeCode' => '81031', + 'abilityTreeNodes' => ['FEATUREclickhouse1YZKWF'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp13s14l8498l****'], ], [ - 'name' => 'DBClusterIds', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群ID。'."\n" - .'>不配置该参数时，默认查询所有集群的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp108z124a8o7****', + '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.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '是否开通监控告警功能', + 'description' => '>该接口仅适用于 2021 年 12 日 01 日之后创建的 20.8 及以上版本的社区兼容版集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckMonitorAlert'], + ], + ], + 'ramActions' => [ [ - 'name' => 'DBClusterDescription', - 'in' => 'query', - 'schema' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp108z124a8o7****', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckMonitorAlert', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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":""}]', + ], + 'CheckScaleOutBalanced' => [ + 'summary' => '对指定云数据库ClickHouse集群进行迁移扩容检测。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DBClusterStatus', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19419', + 'abilityTreeNodes' => ['FEATUREclickhouse07PB80'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群状态，取值说明：'."\n" - .'- **Preparing**：准备中。'."\n" - .'- **Creating**：创建中。'."\n" - .'- **Running**：运行中。'."\n" - .'- **Deleting**：删除中。'."\n" - .'- **SCALING_OUT**：扩容中。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PageSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'Tag', + 'name' => 'PageNumber', '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, - ], + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ScalingType', 'in' => 'query', - 'schema' => [ - 'description' => '集群所属的资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-4690g37929****', - ], + 'schema' => ['description' => '变配类型。'."\n" + .'水平扩容：ScaleOut；'."\n" + .'水平缩容：ScaleIn；'."\n" + .'升级为多可用区部署：MultiAzUpgrade；'."\n" + .'磁盘降配：DiskDownGrade。', 'type' => 'string', 'required' => false, 'example' => 'ScaleOut'], ], ], 'responses' => [ @@ -923,370 +814,82 @@ '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' => [ + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TableDetails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'DBCluster' => [ - 'description' => '集群列表。', + 'TableDetail' => [ + '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', - ], + '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'], ], + 'description' => '', ], ], ], - ], + 'description' => '', + ], + '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'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden', - 'errorMessage' => 'User not authorized to operate on the specified resource.', - ], - ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], - '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', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + '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' => '扩容检查', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckScaleOutBalanced', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'CheckServiceLinkedRole' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1296,504 +899,102 @@ '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****', - ], - ], + 'abilityTreeCode' => '19420', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回的结果。', + 'description' => 'list', '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', - ], + 'RequestId' => ['description' => '唯一请求ID。', 'type' => 'string', 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n"], + 'HasServiceLinkedRole' => ['description' => '是否存在服务关联角色。', 'type' => 'boolean', 'example' => 'true'], ], ], ], ], '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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], - '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', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '查新服务关联角色（SLR）', + 'summary' => '查询云数据库ClickHouse服务关联角色。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', + ], + 'CreateAccount' => [ + 'summary' => '调用CreateAccount接口为指定云数据库ClickHouse集群创建数据库账号。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19440', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '19421', + 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-wz988vja2mor4****', - ], + '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' => [ @@ -1801,248 +1002,275 @@ '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." } ]', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '创建账号', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'CreateAccountAndAuthority' => [ + 'summary' => '创建账号及权限。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19466', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + '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', - ], + '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****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1p816075e21****'], ], [ - 'name' => 'UserConfig', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '变更的配置参数。'."\n" - .'>支持修改单个配置参数。未传入的配置参数不会受到影响。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"keep_alive_timeout":"301"}', - ], + 'schema' => ['description' => '数据库账号。'."\n" + .'- 名称唯一。'."\n" + .'- 由小写字母、数字或下划线组成。'."\n" + .'- 以小写字母开头，以小写字母或数字结尾。'."\n" + .'- 长度为2~64个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ - 'name' => 'Reason', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'description' => '变更说明。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + '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' => [ - 'description' => '返回的结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'A9AA1E0A-2AEE-5847-87CF-E4FDC0E66052', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + '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' => '创建账号及权限', + 'description' => '该接口仅适用于21.8及以下版本，21.8以上版本修改普通用户权限需通过高权限账号使用SQL进行权限更改。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccountAndAuthority'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateAccountAndAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], + ], + ], + ], ], - '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', - ], + 'CreateBackupPolicy' => [ + 'summary' => '创建备份策略。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19445', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '19423', + 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'PreferredBackupTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-t4nw17nh2e4t2****', - ], + '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' => [ - '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>', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '创建备份策略', + 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackupPolicy'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'CreateDBInstance' => [ + 'summary' => '创建一个云数据库ClickHouse集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2051,250 +1279,379 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19464', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '19424', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp19lo45sy98x****', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBNodeGroupCount', + 'name' => 'ZoneId', 'in' => 'query', - 'schema' => [ - 'description' => '节点数量。'."\n" - .'- 单副本版，取值范围：1~48（整数）。'."\n" - .'- 双副本版，取值范围：1~24（整数）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => '可用区ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], ], [ - 'name' => 'DBNodeStorage', + 'name' => 'DBClusterVersion', 'in' => 'query', 'schema' => [ - 'description' => '单个节点的存储空间，单位：GB。'."\n" + 'description' => '内核版本，取值：'."\n" ."\n" - .'取值范围：100~32000。'."\n" + .'- **21.8.10.19**'."\n" ."\n" - .'>步长为100 GB。', + .'- **22.8.5.29**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '100', + 'enumValueTitles' => ['22.8.5.29' => '22.8.5.29', '21.8.10.19' => '21.8.10.19'], + 'example' => '22.8.5.29', ], ], [ - 'name' => 'DBClusterClass', + 'name' => 'DBClusterCategory', '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**', + 'description' => '副本配置，取值说明：'."\n" + .'- **Basic**：单副本版。'."\n" + .'- **HighAvailability**：双副本版。', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'S8', + 'enumValueTitles' => ['Basic' => 'Basic', 'HighAvailability' => 'HighAvailability'], + 'example' => 'Basic', ], ], [ - 'name' => 'RegionId', + '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' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', + 'description' => '付费类型，取值说明：'."\n" + .'- **Postpaid**：按量付费。'."\n" + .'- **Prepaid**：预付费（包年包月）。', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'cn-hangzhou', + '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', - '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', - ], + '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' => 'DisableWriteWindows', + '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' => [ - 'description' => '停写窗口，开始时间和结束时间使用英文逗号隔开，时间使用ISO 8601格式。', - 'type' => 'string', + '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' => 'Example string'], + ], + 'required' => false, + ], 'required' => false, - 'docRequired' => false, - 'example' => '2024-07-09T20:00:00+08:00,2024-07-09T21:00:00+08:00', + 'maxItems' => 20, + 'minItems' => 0, ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回结果。', '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', - ], + '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' => [ - 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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + '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~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateMonitorDataReport' => [ + 'summary' => '创建监控数据报告。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19467', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '81430', + 'abilityTreeNodes' => ['FEATUREclickhouse1YZKWF'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp13s14l8498l****'], ], [ - 'name' => 'DBClusterDescription', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群名称。配置规则如下：'."\n" - .'- 不能以http://或https://开头。'."\n" - .'- 长度为2~256个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ClusterDescriptionTest', - ], + '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' => '05321590-BB65-4720-8CB6-8218E041CDD0', - ], + '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.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '创建监控数据报告', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateMonitorDataReport'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateMonitorDataReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'CreateOSSStorage' => [ + 'summary' => '创建冷存储。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2303,38 +1660,20 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19468', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '19425', + 'abilityTreeNodes' => ['FEATUREclickhouseOCIS36'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'MaintainTime', + 'name' => 'DBClusterId', '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', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1z3a2hc8dmt****'], ], ], 'responses' => [ @@ -2342,248 +1681,121 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '创建冷存储', + 'description' => '仅20.8及以上版本的社区兼容版集群支持冷热分层存储功能。对于不支持的低版本，可以先将数据迁移至20.8及以上版本的集群，再进行冷热分层存储。如何迁移，请参见[云数据库ClickHouse实例间的数据迁移](~~276926~~)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateOSSStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'CreatePortsForClickHouse' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19433', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '25552', + 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'SchemaName', + 'name' => 'PortType', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'database', - ], + 'schema' => ['description' => '端口类型，取值固定为mysql_port。', 'type' => 'string', 'required' => true, 'example' => 'mysql_port'], ], [ - 'name' => 'TableName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '表名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'table', - ], + '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' => '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], ], ], ], - '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', + 'title' => '新增端口', + 'summary' => '开通指定云数据库ClickHouse集群的MySQL或HTTPS端口。', + 'description' => '>在2021年12月01日之前创建的20.8及以上版本的社区兼容版集群需手动开通MySQL端口。在此之后创建的20.8及以上版本的社区兼容版集群会自动开通MySQL端口。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePortsForClickHouse'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreatePortsForClickHouse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'CreateRDSToClickhouseDb' => [ + 'summary' => '调用CreateRDSToClickhouseDb接口创建云数据库ClickHouse社区兼容版同步任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2592,299 +1804,202 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19432', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '45979', + 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DbClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '云数据库ClickHouse的集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-2ze5zeyl72188****'], ], [ - 'name' => 'SchemaName', + 'name' => 'ClickhousePort', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'database', - ], + 'schema' => ['description' => '云数据库ClickHouse的端口号。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8123'], ], [ - 'name' => 'TableName', + 'name' => 'CkUserName', 'in' => 'query', - 'schema' => [ - 'description' => '表名。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'table', - ], + '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' => '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', - ], - ], - ], - ], - ], + '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' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '创建同步任务', + 'description' => '>该接口仅适用于云数据库ClickHouse的社区兼容版集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRDSToClickhouseDb'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateRDSToClickhouseDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'CreateSLB' => [ + 'summary' => '调用CreateSLB接口为指定云数据库ClickHouse社区兼容版集群挂载SLB。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19456', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '143538', + 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + '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' => '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D'], ], ], ], ], - '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', + 'title' => 'CreateSLB', + 'description' => '## 使用说明'."\n" + .'SLB属于网络层依赖，通过域名绑定ClickHouse节点IP来对外提供连接服务，具备故障转移的能力。用于将集群请求均衡转发到集群内部节点进行多节点的流量分发，对于后端节点进行探活。如果节点不可用，可以通过检查节点健康状态并自动隔离异常状态节点，保证请求流量能够分发到可用节点。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateSLB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'CreateSQLAccount' => [ + 'summary' => '调用CreateSQLAccount接口为云数据库ClickHouse集群创建高权限账号或普通账号。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2893,454 +2008,264 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19459', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '152741', + 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY', 'FEATUREclickhouseL1079N'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1p816075e21****'], ], [ - 'name' => 'SchemaName', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'database', - ], + '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' => 'For testing'], + ], + [ + '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' => [ - '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76'], ], ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + '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及以上版本的社区兼容版集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '8', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSQLAccount'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateSQLAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'CreateServiceLinkedRole' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', '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', - ], - ], + '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', - ], - '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', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '创建服务关联角色', + 'summary' => '创建服务关联角色。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DeleteAccount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '38056', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '19427', + 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], + 'tenantRelevance' => 'tenant', ], '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', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'RestartTime', + 'name' => 'AccountName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => '预约重启的时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - .'>当该参数为空或填写早于当前时间时，集群将立即进行重启。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-03-22T00:00:50Z', - ], + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '删除账号', + 'summary' => '删除指定云数据库ClickHouse集群的指定数据库账号。', + 'description' => '>删除指定数据库账号后，将无法通过该账号连接云数据库ClickHouse，请谨慎操作。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAccount'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DeleteBackupPolicy' => [ + 'summary' => '删除ClickHouse社区兼容版备份策略', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '19419', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse07PB80', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '173183', + 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'MaxResults', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '本次读取的最大数据记录数量', 'description' => '每页记录数。取值为**1~100**，默认值为**30**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ - 'name' => 'DBClusterId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '用于保证请求的幂等性。字符串格式，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'], ], [ - 'name' => 'PageSize', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp1t9lbb7a4z7****'], ], [ - 'name' => 'PageNumber', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '产品名称。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], ], ], 'responses' => [ @@ -3348,120 +2273,42 @@ '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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F34'], ], + 'description' => '', ], ], ], - '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 \\"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', + 'title' => '删除备份策略', + 'description' => '>仅21.8及以上版本的云数据库ClickHouse集群支持数据备份功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DeleteDBCluster' => [ + 'summary' => '释放指定的按量付费云数据库ClickHouse集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3470,34 +2317,16 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '19425', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseOCIS36', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '19428', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], + 'tenantRelevance' => 'tenant', ], '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****', - ], + 'schema' => ['description' => '按量付费集群的ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ @@ -3505,158 +2334,117 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '删除集群', + 'description' => '><warning>集群删除后，集群的所有数据都会被删除无法找回，请谨慎操作。'."\n" + .'></warning>'."\n" + ."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBCluster'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteDBCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DeleteSLB' => [ + 'summary' => '为指定云数据库ClickHouse社区兼容版集群释放SLB。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19453', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '142683', + 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。您可以调用[DescribeDBClusters](~~170879~~)接口查看集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-uf6bnitmve5n0****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回参数。', '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], ], ], ], - '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', + 'title' => 'DeleteSLB', + 'description' => '## 使用说明'."\n" + ."\n" + .'SLB释放后将直接基于域名方式对外进行简单负载均衡，失去请求路由层的节点健康状态检查，可能导致正常请求被路由到不可用的异常节点上，造成部分请求读写失败。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteSLB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DeleteSyndb' => [ + 'summary' => '删除同步数据库的任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3665,115 +2453,102 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '43669', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZ93UXU', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '47744', + 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ 'name' => 'DbClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库ClickHouse社区兼容版集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-2zeyy362b5sbm****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp158i5wvj436****'], ], [ - 'name' => 'ClickhousePort', + 'name' => 'SynDb', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库ClickHouse端口号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8123', - ], + 'schema' => ['description' => '云数据库RDS MySQL的数据库。', 'type' => 'string', 'required' => true, 'example' => 'database'], ], - [ - 'name' => 'CkUserName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '云数据库ClickHouse的数据库账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'user1', + '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'], + ], ], ], - [ - 'name' => 'CkPassword', - 'in' => 'query', - 'schema' => [ - 'description' => '云数据库ClickHouse的数据库账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => '123456Aa', - ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], - [ - 'name' => 'RdsId', - 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-bp13v4bnwlu8j****', - ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除同步任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSyndb'], ], + ], + 'ramActions' => [ [ - 'name' => 'RdsPort', - 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS端口号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3306', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteSyndb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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":""}]', + ], + 'DescribeAccountAuthority' => [ + 'summary' => '查看账号权限。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RdsVpcId', - 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS的VPC ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-wz9mm0qka0winfl47****', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19430', + 'abilityTreeNodes' => ['FEATUREclickhouseL1079N'], + ], + 'parameters' => [ [ - 'name' => 'RdsUserName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS的数据库账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'user2', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RdsPassword', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS的数据库账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => '123456Rr', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1p816075e21****'], ], [ - 'name' => 'RdsVpcUrl', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS的内网地址。', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com', - ], + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test'], ], ], 'responses' => [ @@ -3781,54 +2556,78 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID', - 'type' => 'string', - 'example' => 'A82758F8-E793-5610-BE11-0E46664305C2', + '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'], ], - 'Status' => [ - 'description' => '是否能连通，取值说明：'."\n" - ."\n" - .'- **true**：能连通。'."\n" - .'- **false**：不能连通。', - 'type' => 'boolean', - 'example' => 'false', + 'AllowDictionaries' => [ + 'description' => '已授权的字典列表。', + 'type' => 'array', + 'items' => ['description' => '已授权的字典列表。', 'type' => 'string', 'example' => 'dt1'], ], - 'ErrorCode' => [ - 'description' => '- 当**Status**返回为**true**时，不返回该参数。'."\n" - .'- 当**Status**返回为**false**时，表示不能连通的原因。', - 'type' => 'string', - 'example' => 'NotSameVpc', + 'AllowDatabases' => [ + 'description' => '已授权的数据库列表。', + 'type' => 'array', + 'items' => ['description' => '已授权的数据库列表。', 'type' => 'string', 'example' => 'db1'], ], + 'AccountName' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'test'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + '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' => '查看账号权限', + 'description' => '该接口仅适用于21.8及以下版本，21.8以上版本修改普通用户权限需通过高权限账号使用SQL进行权限更改。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeAccounts' => [ + 'summary' => '查询指定云数据库ClickHouse集群的数据库账号信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3838,46 +2637,34 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '44312', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZ93UXU', - ], + 'abilityTreeCode' => '19431', + 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DbClusterId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库ClickHouse的集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1ab22b80814****', - ], + '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' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - 'default' => '20', - ], + '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', - ], + 'schema' => ['description' => '页数，取值为大于0且不超过Integer数据类型的最大值。默认值为**1**。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], ], 'responses' => [ @@ -3885,102 +2672,84 @@ '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' => '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'], + ], + 'description' => '', ], ], ], - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '查询账号信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccounts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeActiveOperationMaintainConf' => [ + 'summary' => '查询Clickhouse实例的主动运维配置。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3990,63 +2759,227 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '46614', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZ93UXU', + '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'], + ], + ], + ], + 'description' => '', + ], ], ], + 'title' => '查询主动运维配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + '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"}]', + ], + 'DescribeActiveOperationTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '201217', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], + ], 'parameters' => [ [ - 'name' => 'DbClusterId', + 'name' => 'Region', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库ClickHouse的集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp158i5wvj436****', - ], + 'schema' => ['description' => '地域信息。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'SynDb', + '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' => '云数据库RDS MySQL的数据库名称。', + 'description' => '数据库类型。', 'type' => 'string', - 'required' => true, - 'example' => 'database', + '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' => [ - 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '851D11EA-681C-5B38-A065-C3F90BBD49DE', - ], - 'Tables' => [ - 'description' => '表信息。', + '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' => '云数据库RDS MySQL的表名。', - 'type' => 'string', - 'example' => 'test', + '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" + .'}'], + ], ], ], ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'description' => '', ], ], ], @@ -4054,19 +2987,19 @@ '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', + 'title' => '查询实例的运维事件详情', + 'summary' => '查询Clickhouse实例的主动运维任务。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + '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"}]', + ], + 'DescribeAllDataSource' => [ + 'summary' => '枚举实例下所有数据库列表、表列表和列列表。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4075,123 +3008,167 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '47744', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZ93UXU', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '19432', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ - 'name' => 'DbClusterId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp158i5wvj436****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'SynDb', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的数据库。', - 'type' => 'string', - 'required' => true, - 'example' => 'database', - ], + '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' => [ - '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', + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], - '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', + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], - 'ErrorCode' => [ - 'description' => '错误码。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '枚举数据库列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAllDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeAllDataSources' => [ + 'summary' => '查看数据源。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '36715', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], + 'abilityTreeCode' => '19433', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + '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' => [ @@ -4199,138 +3176,116 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HistoryDetails' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '75EA41D7-025A-50A6-9287-359A91399F1E'], + 'Tables' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'HistoryDetail' => [ - 'description' => '迁移信息。', + 'Table' => [ + 'description' => '表信息。', 'type' => 'array', 'items' => [ + 'description' => '所有满足条件的表。', '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', - ], + 'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'table'], + 'DBClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp108z124a8o7****'], + 'SchemaName' => ['description' => '数据库名。', 'type' => 'string', 'example' => 'database'], + ], + ], + ], + ], + 'description' => '', + ], + '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'], ], ], ], ], + 'description' => '', ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + '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'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '查看数据源', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAllDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeAutoRenewAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4339,145 +3294,233 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '36417', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse07PB80', - ], + 'abilityTreeCode' => '209424', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'DBClusterId', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => '源集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1tm8zf130ew****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-uf6g4417bo*****'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - ."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + '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' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', ], ], - [ - 'name' => 'TargetDbClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '目标集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp14b39djx7zg****', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '查询ClickHouse社区兼容版实例自动续费信息', + 'summary' => '查询Clickhouse社区兼容版集群的自动续费状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAutoRenewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + '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"}]', + ], + 'DescribeBackupPolicy' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19435', + 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], + ], + 'parameters' => [ [ - 'name' => 'SourceAccount', + 'name' => 'DBClusterId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1qx68m06981****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '源账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', + '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'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查看备份策略', + 'summary' => '查看指定云数据库ClickHouse集群的备份设置。', + 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + '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":""}]', + ], + 'DescribeBackups' => [ + 'summary' => '查看指定云数据库ClickHouse集群的备份集。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19436', + 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], + ], + 'parameters' => [ [ - 'name' => 'TargetAccount', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '目标账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'test01', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1qx68m06981****'], ], [ - 'name' => 'SourcePassword', + 'name' => 'BackupId', 'in' => 'query', - 'schema' => [ - 'description' => '源账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => '123456Aa', - ], + 'schema' => ['description' => '备份数据任务ID。'."\n", 'type' => 'string', 'required' => false, 'example' => '117403****'], ], [ - 'name' => 'TargetPassword', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '目标账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => '123456Ff', - ], + 'schema' => ['description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-21T16:00Z'], ], [ - 'name' => 'DisableWriteWindows', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '停写窗口。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', - ], + 'schema' => ['description' => '查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-25T16:00Z'], ], [ - 'name' => 'SourceClusterName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '自建ClickHouse集群的cluster名称。'."\n" - .'可通过执行`SELECT * FROM system.clusters`获取。', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], ], [ - 'name' => 'SourceShards', + 'name' => 'PageNumber', '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', - ], + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], ], ], 'responses' => [ @@ -4485,211 +3528,285 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7084CDB5-308F-5D0B-8F9B-5F7D83E09738', + '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'], + 'BackupScheduleType' => ['description' => '备份类型。取值manual（手动备份）/ scheduled（自动备份）', 'type' => 'string', 'example' => 'manual'], + ], + 'description' => '', + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + '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 \\"BackupScheduleType\\": \\"manual\\"\\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集群支持数据备份功能。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeColumns' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '19426', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', + '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'], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0', + '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'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '查看列', + 'summary' => '查看列。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeColumns', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeConfigHistory' => [ + 'summary' => '调用DescribeConfigHistory接口查看云数据库ClickHouse社区兼容版集群配置参数的变更记录。', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19460', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '145141', + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1p816075e21****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '查询开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'required' => true, 'example' => '2022-08-11T06:27:00Z'], ], [ - 'name' => 'InitialQueryId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '需要停止的查询语句。如果有多个语句，用“,”隔开。'."\n" - .'>不配置该参数时，默认停止所有查询语句。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'SELECT * FROM `test01` ;', - ], + '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' => '05321590-BB65-4720-8CB6-8218E041CDD0', + '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'], + ], + 'description' => '', + ], ], ], ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], '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', + 'title' => '查看配置参数的变更记录', + 'description' => '> 该接口仅支持2021年12月01日之后创建的社区兼容版集群。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeConfigHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeConfigVersionDifference' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4699,104 +3816,129 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '19457', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseLESIXD', - ], + 'abilityTreeCode' => '145140', + '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-bp1z58t881wcx****', - ], + 'schema' => ['description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1tm8zf130ew****'], ], [ - 'name' => 'StartTime', + 'name' => 'ChangeId', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-05-20 16:00:00', - ], + 'schema' => ['description' => '变更记录的ID。您可以通过调用[DescribeConfigHistory](~~452209~~)接口查询变更记录的ID。', 'type' => 'string', 'required' => true, 'example' => '1'], ], - [ - 'name' => 'EndTime', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询结束时间，格式：yyyy-MM-dd hh:mm:ss（UTC时间）。'."\n" - .'>查询结束时间需晚于查询开始时间，且与查询开始时间间隔小于7天。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-05-27 16:00:00', + '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>"'], + ], ], ], - [ - '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', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查看配置参数变更前后的参数值', + 'summary' => '调用DescribeConfigVersionDifference接口查看云数据库ClickHouse社区兼容版集群配置参数变更前后的参数值。', + 'description' => '> 该接口仅支持2021年12月01日之后创建的社区兼容版集群。'."\n" + ."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeConfigVersionDifference', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + '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":""}]', + ], + 'DescribeDBClusterAccessWhiteList' => [ + 'summary' => '查看指定云数据库ClickHouse集群的IP白名单。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - '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', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19438', + 'abilityTreeNodes' => ['FEATUREclickhouseW0KOAC'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'QueryDurationMs', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '最短的查询耗时。最小值为**1000**，默认值为**1000**。单位：毫秒。返回参数将返回超过该耗时的查询。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9999999999', - 'minimum' => '0', - 'example' => '1000', - 'isFileTransferUrl' => false, - 'default' => '1000', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ @@ -4804,183 +3946,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A', - ], - 'SlowLogRecords' => [ - 'description' => '慢日志明细列表。', + 'DBClusterAccessWhiteList' => [ 'type' => 'object', + 'itemNode' => true, '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', + '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'], ], + 'description' => '', ], ], ], + 'description' => '', ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '905F13A4-5097-4897-A84D-527EC75FFF4F'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '查看集群的IP白名单', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAccessWhiteList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterAccessWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeDBClusterAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4992,257 +4017,249 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '19442', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseLESIXD', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '19439', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], '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', - ], + 'schema' => ['description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '返回的结果。', '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****', + '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'], ], ], ], ], - 'Name' => [ - 'description' => '性能值名称。', - 'type' => 'string', - 'example' => 'mem_usage', + 'description' => '', + ], + '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' => ['description' => 'LoadBalance类型。', 'type' => 'string', 'example' => 'clb'], + '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****'], + 'WebUIStatus' => ['type' => 'string', 'example' => 'active'], + 'WebUISnatStatus' => ['type' => 'string', 'example' => 'active'], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], ], - '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', + 'title' => '查看集群的详细属性', + 'summary' => '查询指定云数据库ClickHouse集群的信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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\\": \\"clb\\",\\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 \\"WebUIStatus\\": \\"active\\",\\n \\"WebUISnatStatus\\": \\"active\\"\\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":""}]', + ], + 'DescribeDBClusterConfig' => [ + 'summary' => '调用DescribeDBClusterConfig接口查询社区兼容版集群的参数配置信息。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '147860', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseN0HBPQ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '19440', + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], - ], - [ - 'name' => 'UpgradeImmediately', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '是否立即升级，取值说明：'."\n" - ."\n" - .'- **true**：立即升级。'."\n" - ."\n" - .'- **false**：指定时间升级或可维护时间升级。'."\n" - ."\n" - .'>如果是指定时间升级内核小版本，那么**UpgradeTime**为必填项。'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'UpgradeVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '升级的内核小版本号。'."\n" - .'> 默认不填写，直接升级到最新的内核小版本。', - 'type' => 'string', - 'required' => false, - 'example' => '1.37.0', - ], - ], - [ - 'name' => 'UpgradeTime', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '指定的升级时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - .'>当不填写该参数时，则云数据库ClickHouse集群将在可维护时间内进行内核小版本升级。', - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-07T16:38Z', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-wz988vja2mor4****'], ], ], 'responses' => [ @@ -5250,41 +4267,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', - ], + '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." } ]'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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", + 'title' => '查看集群参数配置信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + '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":""}]', ], 'DescribeDBClusterConfigInXML' => [ 'summary' => '调用DescribeDBClusterConfigInXML接口查询云数据库ClickHouse社区兼容版集群XML模式下的配置参数。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5295,30 +4321,18 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '153858', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + '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****', - ], + 'schema' => ['description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ @@ -5328,40 +4342,31 @@ '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>', - ], + '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>'], ], ], ], @@ -5370,114 +4375,125 @@ '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterConfigInXML', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeDBClusterNetInfoItems' => [ + 'summary' => '查询指定云数据库ClickHouse集群的网络信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '153825', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], - ], + 'systemTags' => ['operationType' => 'get', 'tenantRelevance' => 'tenant'], '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', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1qx68m06981****'], ], ], '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', + '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'], + ], + ], + ], + ], + 'description' => '', ], + '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'], ], + 'description' => '', ], ], ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], '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', + 'title' => '查看网络信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterNetInfoItems'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterNetInfoItems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeDBClusterNodeInfos' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5487,51 +4503,34 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '152285', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], + '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。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1tm8zf130ew****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'Config', + 'name' => 'PageSize', '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>', - ], + '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' => [ @@ -5541,39 +4540,70 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'NeedRestart' => [ - 'description' => '变更配置参数后是否重启。取值说明：'."\n" - .'- **true**：重启。'."\n" - .'- **false**：不重启。', - 'type' => 'boolean', - 'example' => 'true', + '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'], + ], + ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C', + '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'], + ], + 'description' => '', + ], ], + '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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], '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', + 'title' => '获取实例节点信息', + 'summary' => '获取ClickHouse社区兼容版实例节点信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + '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"}]', + ], + 'DescribeDBClusterPerformance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5583,88 +4613,108 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '145141', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19442', + 'abilityTreeNodes' => ['FEATUREclickhouseLESIXD'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1p816075e21****', - ], + '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:mm:ssZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2022-08-11T06:27:00Z', - ], + '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:mm:ssZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'example' => '2022-08-22T10:06:00Z', - ], + 'schema' => ['description' => '查询结束时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'>查询结束时间需晚于开始时间，且开始时间和结束时间的时间间隔不能超过32天。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-27T16:38Z'], ], ], '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' => '配置参数的变更记录。', + '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' => [ - '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', + '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'], ], ], ], @@ -5672,31 +4722,36 @@ ], ], ], - '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', + 'title' => '查看性能数据', + 'summary' => '调用DescribeDBClusterPerformance接口查看云数据库ClickHouse社区兼容版集群的性能数据。', + 'description' => '根据性能参数查看指定集群在某时间段范围内的性能监控数据。采集粒度为30秒。'."\n" + .'>该接口仅支持2021年12月01日之前创建的云数据库ClickHouse社区兼容版集群。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterPerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeDBClusterStatusSet' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5706,126 +4761,47 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '145140', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'abilityTreeCode' => '19444', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1tm8zf130ew****', - ], - ], - [ - 'name' => 'ChangeId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '变更记录的ID。您可以通过调用[DescribeConfigHistory](~~452209~~)接口查询变更记录的ID。', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], ], '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>"', + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'DE309AA1-BD83-5E1F-9945-8A4D336E0829'], + 'StatusSet' => [ + 'description' => '实例状态集合。', + 'type' => 'array', + 'items' => ['description' => '实例状态集合。', 'type' => 'string', 'example' => 'ACTIVATION'], ], ], + 'description' => '', ], ], ], - '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' => [], + 'title' => '查询ClickHouse实例状态集合', + 'summary' => '查询Clickhouse社区兼容版集群的状态集。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE309AA1-BD83-5E1F-9945-8A4D336E0829\\",\\n \\"StatusSet\\": [\\n \\"ACTIVATION\\"\\n ]\\n}","type":"json"}]', ], - 'CreateRDSToClickhouseDb' => [ - 'summary' => '调用CreateRDSToClickhouseDb接口创建云数据库ClickHouse社区兼容版同步任务。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeDBClusters' => [ + 'summary' => '查询云数据库ClickHouse指定地域的集群信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5834,316 +4810,361 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '45979', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZ93UXU', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '19443', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], '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', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'rm-8vb989qj9roh0****', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RdsPort', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的端口号。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3306', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'>不配置该参数时，默认查询所有集群的信息。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'RdsVpcId', + 'name' => 'DBClusterDescription', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的VPC ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-2zen93xryil99jsfy****', - ], + 'schema' => ['description' => '集群描述。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'RdsUserName', + 'name' => 'DBClusterStatus', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的数据库账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'user2', - ], + 'schema' => ['description' => '集群状态，取值说明：'."\n" + .'- **Preparing**：准备中。'."\n" + .'- **Creating**：创建中。'."\n" + .'- **Running**：运行中。'."\n" + .'- **Deleting**：删除中。'."\n" + .'- **SCALING_OUT**：扩容中。'."\n", 'type' => 'string', 'required' => false, 'example' => 'Running'], ], [ - 'name' => 'RdsPassword', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的数据库账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => '123456Rr', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'SkipUnsupported', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '是否忽略不支持同步的表结构，取值说明：'."\n" - ."\n" - .'- **true**：忽略。'."\n" - .'- **false**：不忽略。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'LimitUpper', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '每秒最多同步的行数。', - 'type' => 'integer', - 'format' => 'int64', + '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, - '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"]}]', + 'maxItems' => 21, ], ], [ - 'name' => 'RdsVpcUrl', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS的内网地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com', - ], + 'schema' => ['description' => '集群所属的资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****'], ], ], '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"]', + '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'], + ], + ], + ], + ], + 'description' => '', + ], + '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'], + ], + ], + ], ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 403 => [ + ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => '账户未被授予操作资源的权限'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], - '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', + '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' => '查询集群列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'DescribeDBConfig' => [ + 'summary' => '调用DescribeDBConfig接口查询社区兼容版集群的配置信息。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19469', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + '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', - ], + '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>', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-t4nw17nh2e4t2****'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '返回的结果。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'BF3844B6-1B12-57A0-A259-476D2079EE83', - ], + '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.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '查询字典配置信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeEventMetaInfo' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6152,214 +5173,147 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '47742', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZ93UXU', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201222', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], + 'tenantRelevance' => 'tenant', ], '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', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的数据库账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'user2', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'RdsPassword', + 'name' => 'SourceCode', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的数据库账号密码。', - 'type' => 'string', - 'required' => true, - 'example' => '123456Rr', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => '运维事件类型代码，多个英文逗号分隔', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Event.EventCode'], ], - [ - 'name' => 'SkipUnsupported', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否忽略不支持同步的库，取值说明：'."\n" - ."\n" - .'- **true**：忽略。'."\n" - .'- **false**：不忽略。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', + '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'], + 'title' => '查询事件中心事件元信息', + 'summary' => '查询Clickhouse社区兼容版集群的运维事件元信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + '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"}]', + ], + 'DescribeOSSStorage' => [ + 'summary' => '查看冷存。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LimitUpper', - 'in' => 'query', - 'schema' => [ - 'description' => '每秒最多同步的行数。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50000', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '19453', + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], + ], + 'parameters' => [ [ - 'name' => 'RdsSynTables', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的表。', - 'type' => 'string', - 'required' => true, - 'example' => 'table', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RdsSynDb', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '云数据库RDS MySQL的数据库。', - 'type' => 'string', - 'required' => true, - 'example' => 'database', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], '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', - ], + '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'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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的社区兼容版集群。', + 'title' => '查看冷存', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeOSSStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + '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":""}]', ], 'DescribeProcessList' => [ - 'summary' => '调用DescribeProcessList接口查询云数据库ClickHouse社区兼容版集群正在运行的查询。', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6370,124 +5324,60 @@ 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19454', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseLESIXD', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseLESIXD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + '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****', - ], + '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, - ], + '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', - ], + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => false, 'example' => 'user'], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '查询关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'join', - ], + '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', - ], + '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', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '查询语句的ID。', 'type' => 'string', 'required' => false, 'example' => '6c69d508-f05f-4c74-857c-d982b7e7e79f'], ], ], 'responses' => [ @@ -6496,11 +5386,7 @@ 'description' => '返回的结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FD61BB0D-788A-5185-A8E3-1B90BA8F6F04', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FD61BB0D-788A-5185-A8E3-1B90BA8F6F04'], 'ProcessList' => [ 'description' => '任务列表', 'type' => 'object', @@ -6515,20 +5401,14 @@ 'items' => [ 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '列类型。', - 'type' => 'string', - 'example' => 'String', - ], - 'Name' => [ - 'description' => '列名。', - 'type' => 'string', - 'example' => 'InitialUser', - ], + 'Type' => ['description' => '列类型。', 'type' => 'string', 'example' => 'String'], + 'Name' => ['description' => '列名。', 'type' => 'string', 'example' => 'InitialUser'], ], + 'description' => '', ], ], ], + 'description' => '', ], 'Data' => [ 'type' => 'object', @@ -6540,73 +5420,28 @@ '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', - ], + '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'], ], + 'description' => '', ], ], ], + 'description' => '', ], - 'Rows' => [ - 'description' => '查询返回的数据行数。', - 'type' => 'string', - 'example' => '1145700', - ], - 'RowsBeforeLimitAtLeast' => [ - 'description' => '分页大小。', - 'type' => 'string', - 'example' => '1', - ], + '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', - ], + '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'], ], ], ], @@ -6617,224 +5452,136 @@ ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'summary' => '调用DescribeProcessList接口查询云数据库ClickHouse社区兼容版集群正在运行的查询。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeProcessList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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"}]', + ], + 'DescribeRegions' => [ + 'summary' => '查询云数据库ClickHouse所有地域和可用区的信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', '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', - ], - ], + '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', + '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'], + ], + ], + ], + ], + 'description' => '', + ], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 'title' => '查看可选的地域和可用区', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], ], ], - '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集群支持数据备份。', + 'ramActions' => [], + '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":""}]', ], - 'ModifyBackupPolicy' => [ - 'summary' => '修改指定云数据库ClickHouse集群的备份设置。', - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeSchemas' => [ + 'summary' => '枚举实例下所有数据库列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19463', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseYFBZ0B', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '19456', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], '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', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ @@ -6842,42 +5589,67 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '枚举实例下所有数据库列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => '查看慢日志明细。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6887,22 +5659,48 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '19435', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseYFBZ0B', - ], + '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。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1qx68m06981****', - ], + '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' => [ @@ -6910,167 +5708,151 @@ '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', + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + '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'], + ], + 'description' => '', + ], + ], + ], + 'description' => '', + ], + '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'], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '查看慢日志明细', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeSlowLogTrend' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '19436', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseYFBZ0B', - ], + 'abilityTreeCode' => '19458', + 'abilityTreeNodes' => ['FEATUREclickhouseLESIXD'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1qx68m06981****', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'BackupId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '备份数据任务ID。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '117403****', - ], + 'schema' => ['description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp11xxl475ui8****'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-11-21T16:00Z', - ], + '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-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', - ], + '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' => 'PageNumber', + 'name' => 'QueryDurationMs', 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => '慢SQL的执行耗时。最小值为**1000**，默认值为**1000**。单位：毫秒。返回参数将返回超过该耗时的慢SQL。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'example' => '1000', 'isFileTransferUrl' => false, 'default' => '1000'], ], ], 'responses' => [ @@ -7078,239 +5860,209 @@ '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****', + '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'], + ], + ], + ], ], - 'BackupMethod' => [ - 'description' => '备份方式。唯一取值为**Physical**，代表物理备份。', - 'type' => 'string', - 'example' => 'Physical', + 'description' => '', + ], + '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'], + ], + ], + ], ], - 'ExpireDate' => [ - 'description' => '备份集到期时间。'."\n" - .'格式：yyyy-MM-ddTHH:mmZ（UTC时间）。', - 'type' => 'string', - 'example' => '2022-07-22T18:28:41Z', + 'description' => '', + ], + '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'], ], ], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '查看集群慢日志趋势统计情况', + 'summary' => '查看集群慢日志趋势统计情况。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeSynDbTables' => [ + 'summary' => '查看同步数据库与表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '25552', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZHDS8I', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '46614', + 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp108z124a8o7****', - ], - ], - [ - 'name' => 'PortType', + 'name' => 'DbClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '端口类型，取值固定为mysql_port。', - 'type' => 'string', - 'required' => true, - 'example' => 'mysql_port', - ], + 'schema' => ['description' => '云数据库ClickHouse的集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp158i5wvj436****'], ], [ - 'name' => 'RegionId', + 'name' => 'SynDb', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '云数据库RDS MySQL的数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'database'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + '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.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], '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', + 'title' => '查看同步数据库与表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSynDbTables'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSynDbTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeSynDbs' => [ + 'summary' => '查看同步db。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19472', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZHDS8I', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '44312', + 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DbClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + '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' => [ @@ -7318,40 +6070,70 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + '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'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '查看同步db', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSynDbs'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSynDbs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeTables' => [ + 'summary' => '调用DescribeTables接口查询社区兼容版集群的表信息。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7360,35 +6142,20 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19418', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZHDS8I', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '19459', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'SchemaName', 'in' => 'query', - 'schema' => [ - 'description' => '连接数据库的地址前辍，取值固定为集群ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '数据库名。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'database'], ], ], 'responses' => [ @@ -7396,40 +6163,68 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + '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'], + ], + ], + ], + ], + 'description' => '', ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '查看表信息', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'DescribeTransferHistory' => [ + 'summary' => '查看迁移记录。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7439,19 +6234,16 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'tenantRelevance' => 'tenant', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36715', + 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1qx68m06981****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ @@ -7459,118 +6251,82 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'NetInfoItems' => [ + 'HistoryDetails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ - 'NetInfoItem' => [ - 'description' => '网络信息列表。', + 'HistoryDetail' => [ + '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', - ], + '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' => ['description' => '子任务信息。', 'type' => 'string', 'example' => 'Code: 210. DB::NetException: Connection refused (ck-****-****-clickhouse-s-0-r-0.ck-****-****-clickhouse-headless.ck-****.svc.cluster.local:3003). (NETWORK_ERROR) (version 22.8.5.29)'], ], + 'description' => '', ], ], ], + 'description' => '', ], - '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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + '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\\": \\"Code: 210. DB::NetException: Connection refused (ck-****-****-clickhouse-s-0-r-0.ck-****-****-clickhouse-headless.ck-****.svc.cluster.local:3003). (NETWORK_ERROR) (version 22.8.5.29)\\"\\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集群之间低版本向高版本的数据迁移信息。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeTransferHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + ], + 'DescribeUserEncryptionKeyList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7580,61 +6336,27 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '19431', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse2H8YOY', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '220406', + 'abilityTreeNodes' => ['FEATUREclickhouseY04H6E'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AccountName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的名称。'."\n" - .'>如果不配置该参数，默认查询所有数据库账号的信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'testAccount', - ], + 'schema' => ['description' => '当前页码。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ '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', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'string', 'required' => false, 'example' => '30'], ], ], 'responses' => [ @@ -7642,90 +6364,20 @@ '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', - ], - ], - ], + '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"], ], ], ], ], - ], - ], - ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + 'description' => '', ], ], ], @@ -7733,128 +6385,106 @@ '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', + 'title' => '查看KMS密钥列表', + 'summary' => '查询用户KMS密钥列表。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"KmsKeys\\": [\\n {\\n \\"KeyId\\": \\"0275bd3f-fdbb-4d8c-846b-71b211******\\\\n\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ElectZookeeperLeader' => [ + 'summary' => 'ClickHouse社区兼容版实例Zookeeper主动切主', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '19421', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse2H8YOY', - ], - 'tenantRelevance' => 'tenant', + '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****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'AccountName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号。'."\n" - .'>- 名称唯一。'."\n" - .'- 由小写字母、数字或下划线组成。'."\n" - .'- 以小写字母开头，以小写字母或数字结尾。'."\n" - .'- 长度为2~64个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'AccountPassword', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的密码。'."\n" - .'>- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" - .'- 特殊字符为!@#$%^&*()_+-='."\n" - .'- 长度为8~32个字符。'."\n" - ."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123789Ff!', - ], + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'AccountDescription', + 'name' => 'DisableWrite', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的描述。'."\n" - .'>- 不能以http://或https://开头。'."\n" - .'- 长度为0~256个字符。'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ceshi', - ], + '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' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF'], ], ], ], ], '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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], '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', + 'title' => 'Zookeeper自动切主', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\"\\n}","type":"json"}]', + ], + 'KillProcess' => [ + 'summary' => '终止正在进行的任务。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7863,249 +6493,253 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '152741', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse2H8YOY', - 'FEATUREclickhouseL1079N', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '19460', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], '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', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的密码。'."\n" - .'- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" - .'- !@#$%^&*()_+-=为特殊字符。'."\n" - .'- 长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'Test1234', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AccountDescription', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的描述。'."\n" - .'- 不能以http://或https://开头。'."\n" - .'- 长度为0~256个字符。', - 'type' => 'string', - 'required' => false, - 'example' => '测试使用', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'AccountType', + 'name' => 'InitialQueryId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的类型，取值说明：'."\n" - .'- **Super**：高权限账号。'."\n" - .'- **Normal**：普通账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'Super', - ], + 'schema' => ['description' => '需要停止的查询语句。如果有多个语句，用“,”隔开。'."\n" + .'>不配置该参数时，默认停止所有查询语句。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'SELECT * FROM `test01` ;'], ], ], '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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '终止正在进行的任务', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:KillProcess', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'ListTagResources' => [ + 'summary' => '查询云数据库ClickHouse集群已绑定的标签列表。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '19427', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse2H8YOY', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'list', + 'abilityTreeCode' => '166149', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + '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' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', + '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' => 'AccountName', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', + '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' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + '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****'], + ], + 'description' => '', + ], ], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], - ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAccountResponse>\\n <RequestId>2FED790E-FB61-4721-8C1C-07C627FA5A19</RequestId>\\n</DeleteAccountResponse>","errorExample":""}]', - 'title' => '删除账号', - 'description' => '>删除指定数据库账号后，将无法通过该账号连接云数据库ClickHouse，请谨慎操作。', - ], - 'ResetAccountPassword' => [ - 'summary' => '重置指定云数据库ClickHouse集群的指定数据库账号密码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '查询实例绑定的标签列表', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + '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":""}]', + ], + 'ModifyAccountAuthority' => [ + 'summary' => '修改账号权限。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '19473', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse2H8YOY', - ], - 'tenantRelevance' => 'tenant', + '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****', - ], + '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', - ], + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ - 'name' => 'AccountPassword', + 'name' => 'DmlAuthority', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的新密码。'."\n" - .'>- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" - .'- 特殊字符为!@#$%^&*()_+-='."\n" - .'- 长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456Ff', - ], + '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' => [ @@ -8113,40 +6747,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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' => '重置账号密码', + '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' => '修改账号权限', + 'description' => '该接口仅适用于21.8及以下版本，21.8以上版本修改普通用户权限需通过高权限账号使用SQL进行权限更改。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountAuthority'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], ], 'ModifyAccountDescription' => [ 'summary' => '修改指定云数据库ClickHouse集群的指定数据库账号描述。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8157,46 +6805,26 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19462', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '数据库账号的新描述。'."\n" + .'- 不能以http://和https://开头。'."\n" + .'- 长度为0~256个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ceshi'], ], ], 'responses' => [ @@ -8204,190 +6832,93 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyActiveOperationMaintainConf' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '19422', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseL1079N', - 'FEATUREclickhouse2H8YOY', - ], - ], + 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], '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', + 'name' => 'CycleType', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号。'."\n" - .'- 名称唯一。'."\n" - .'- 由小写字母、数字或下划线组成。'."\n" - .'- 以小写字母开头，以小写字母或数字结尾。'."\n" - .'- 长度为2~64个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '周期类型。'."\n" + ."\n" + .'- Month 每月'."\n" + .'- Week 每周', 'type' => 'string', 'required' => false, 'example' => 'Week'], ], [ - 'name' => 'AccountPassword', + 'name' => 'CycleTime', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的密码。'."\n" - .'>- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" - .'- 特殊字符为!@#$%^&*()_+-='."\n" - .'- 长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456Aa', - ], + 'schema' => ['description' => '周期时间。'."\n" + ."\n" + .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" + .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'AccountDescription', + 'name' => 'MaintainStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的描述。'."\n" - .'- 不能以http://或https://开头。'."\n" - .'- 长度为0~256个字符。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ceshi', - ], + 'schema' => ['description' => '任务开始时间。格式为[unk]yyyy-mm-ddthh:mm:ssz[unk]（utc时间）。', 'type' => 'string', 'required' => false, 'example' => '07:00Z'], ], [ - 'name' => 'DmlAuthority', + 'name' => 'MaintainEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '是否授予数据库账号DML权限，取值说明：'."\n" - ."\n" - .'- **all**：读写和设置权限。'."\n" - .'- **readOnly,modify**：读取和设置权限。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'all', - ], + 'schema' => ['description' => '可维护时间段的结束时间。格式为[unk]hh:mmz-hh:mmz[unk]（utc 时间）。', 'type' => 'string', 'required' => false, 'example' => '20:00Z'], ], [ - 'name' => 'DdlAuthority', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" + 'description' => '是否生效，取值说明：'."\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', + .'- **1**：是。'."\n" + .'- **2**：否。', + 'type' => 'integer', + 'format' => 'int32', 'required' => false, - 'docRequired' => false, - 'example' => 'dt1,dt2', + 'enumValueTitles' => [], + 'example' => '1', + 'enum' => ['1', '2'], ], ], ], @@ -8396,96 +6927,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAccountAndAuthorityResponse>\\n <RequestId>F5178C10-1407-4987-9133-DE4DC9119F75</RequestId>\\n</CreateAccountAndAuthorityResponse>","errorExample":""}]', - 'title' => '创建账号及权限', - ], - 'DescribeAccountAuthority' => [ - 'summary' => '查看账号权限。', - 'methods' => [ - 'post', - 'get', - 'put', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '修改主动运维事件', + 'summary' => '修改Clickhouse社区兼容版集群的主动运维任务配置。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', + ], + 'ModifyActiveOperationTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19430', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseL1079N', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '201218', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Ids', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '运维任务ID，多个ID间使用英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '188****,188****,188****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'SwitchTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1p816075e21****', - ], + 'schema' => ['description' => '后台发起切换操作的时间点，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-09T05:00:00Z'], ], [ - 'name' => 'AccountName', + 'name' => 'ImmediateStart', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '是否立即执行运维任务，取值：'."\n" + ."\n" + .'- **1**：立即执行。'."\n" + .'- **0**：指定时间执行。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ @@ -8493,83 +6987,10 @@ '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', - ], + 'Ids' => ['description' => '运维事件 ID，多个 ID 间使用英文逗号（,）分隔。', 'type' => 'string', 'example' => '188****,188****,188****'], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '617242AA-04D8-5AF0-8C0C-6E53DDA8C3C3'], ], - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', + 'description' => '', ], ], ], @@ -8577,138 +6998,149 @@ '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', + 'title' => '修改实例计划内运维事件的切换时间', + 'summary' => '修改Clickhouse社区兼容版集群运维事件的切换时间', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"188****,188****,188****\\",\\n \\"RequestId\\": \\"617242AA-04D8-5AF0-8C0C-6E53DDA8C3C3\\"\\n}","type":"json"}]', + ], + 'ModifyAutoRenewAttribute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '19461', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseL1079N', - ], - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。'."\n" + .'如果有多个集群ID，以英文逗号（,）分隔。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1uy5ff6*****'], ], [ - 'name' => 'DBClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], ], [ - 'name' => 'AccountName', + 'name' => 'RenewalStatus', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '续费状态。取值：'."\n" + ."\n" + .'- **AutoRenewal**：自动续费；'."\n" + ."\n" + .'- **Normal**：手动续费；'."\n" + ."\n" + .'- **NotRenewal**：到期不续费。', 'type' => 'string', 'required' => false, 'example' => 'AutoRenewal', 'default' => 'AutoRenewal'], ], [ - 'name' => 'DmlAuthority', + 'name' => 'Duration', 'in' => 'query', - 'schema' => [ - 'description' => '是否授予数据库账号DML权限，取值说明：'."\n" - ."\n" - .'- **all**：读写和设置权限。'."\n" - .'- **readonly,modify**：读取和设置权限。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'all', - ], + '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' => 'DdlAuthority', + 'name' => 'PeriodUnit', 'in' => 'query', + 'schema' => ['description' => '续费时长的时间单位，即参数Duration的单位。取值范围：Month，Year', 'type' => 'string', 'required' => false, 'example' => 'Year', 'default' => 'Month'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" - ."\n" - .'- **true**：允许DDL。'."\n" - .'- **false**：禁止DDL。'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7B94AB34-6875-56D2-92B4-0C2******'], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '修改ClickHouse社区兼容版集群自动续费状态', + 'summary' => '修改Clickhouse社区兼容版集群的自动续费状态。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAutoRenewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B94AB34-6875-56D2-92B4-0C2******\\"\\n}","type":"json"}]', + ], + 'ModifyBackupPolicy' => [ + 'summary' => '修改指定云数据库ClickHouse集群的备份设置。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AllowDatabases', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '19463', + 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], + ], + 'parameters' => [ + [ + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '需要授权的数据库列表。如果有多个，用“,”隔开。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'db1', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1qx68m06981****'], ], [ - 'name' => 'TotalDatabases', + 'name' => 'PreferredBackupTime', 'in' => 'query', - 'schema' => [ - 'description' => '所有数据库列表。如果有多个，用“,”隔开。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'db1,db2', - ], + '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' => 'AllowDictionaries', + 'name' => 'PreferredBackupPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '需要授权的字典列表。如果有多个，用“,”隔开。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dt1', - ], + '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' => 'TotalDictionaries', + 'name' => 'BackupRetentionPeriod', 'in' => 'query', - 'schema' => [ - 'description' => '所有字典列表。如果有多个，用“,”隔开。', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dt1,dt2', - ], + 'schema' => ['description' => '数据备份天数。取值范围：7天~730天。', 'type' => 'string', 'required' => false, 'example' => '7', 'default' => '7'], ], ], 'responses' => [ @@ -8716,78 +7148,118 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '修改备份策略', + 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyDBCluster' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19438', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseW0KOAC', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'update', + 'abilityTreeCode' => '19464', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', - ], + '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' => [ @@ -8795,70 +7267,54 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DBClusterAccessWhiteList' => [ + 'DBCluster' => [ + 'description' => '集群。', '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', - ], - ], - ], - ], + 'dbClusterId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp19lo45sy98x****'], + 'orderId' => ['description' => '订单ID。', 'type' => 'string', 'example' => '21417210003****'], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '905F13A4-5097-4897-A84D-527EC75FFF4F', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BA30A000-3A4D-5B97-9420-E5D0D49F7016'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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白名单', + 'title' => '对集群进行升降配', + 'summary' => '对集群进行升降配。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + '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":""}]', ], 'ModifyDBClusterAccessWhiteList' => [ 'summary' => '修改指定云数据库ClickHouse集群的IP白名单。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -8869,74 +7325,45 @@ 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19465', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseW0KOAC', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseW0KOAC'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1qx68m06981****', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '需要修改的白名单分组名称。'."\n" + .'>不配置该参数时，默认修改default分组中的白名单。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ 'name' => 'DBClusterIPArrayAttribute', 'in' => 'query', - 'schema' => [ - 'description' => '白名单分组属性，默认为**空**。', - 'type' => 'string', - 'required' => false, - 'example' => 'NULL', - ], + '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', - ], + 'schema' => ['description' => '修改方式，取值说明：'."\n" + ."\n" + .'- **Cover**：覆盖原白名单。'."\n" + .'- **Append**：在原白名单后追加修改的白名单。'."\n" + .'- **Delete**：删除原白名单。'."\n" + ."\n" + .'>不配置该参数时，默认采用Cover方式修改白名单。', 'type' => 'string', 'required' => false, 'example' => 'Cover'], ], ], 'responses' => [ @@ -8944,153 +7371,164 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAccessWhiteList'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterAccessWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyDBClusterConfig' => [ + 'summary' => '修改集群配置。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '81430', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse1YZKWF', - ], + '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。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp13s14l8498l****', - ], + 'schema' => ['description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1t9lbb7a4z7****'], ], [ - 'name' => 'RegionId', + 'name' => 'UserConfig', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + '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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回的结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'A9AA1E0A-2AEE-5847-87CF-E4FDC0E66052'], ], ], ], ], '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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '修改集群配置', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyDBClusterConfigInXML' => [ + 'summary' => '变更指定云数据库ClickHouse社区兼容版集群的配置参数。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '81031', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse1YZKWF', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '153825', + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp13s14l8498l****', - ], + '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', - ], + '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' => [ @@ -9100,120 +7538,110 @@ '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" } }', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'BDD29EB1-BE76-5CFA-9068-D34B696310BF'], ], ], ], ], - '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', + 'title' => '变更配置参数', + 'description' => '>该接口仅支持2021年12月01日之后创建的社区兼容版集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterConfigInXML', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyDBClusterDescription' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19420', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', + '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'], ], ], - '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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], - ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '修改集群名称', + 'summary' => '修改指定云数据库ClickHouse集群的名称。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyDBClusterMaintainTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9223,35 +7651,23 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '147864', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseN0HBPQ', - ], + 'abilityTreeCode' => '19468', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp1qx68m06981****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'MaintainAutoType', + 'name' => 'MaintainTime', 'in' => 'query', - 'schema' => [ - 'description' => '升级类型。'."\n" - .'**false**为手动升级。', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + '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' => [ @@ -9259,40 +7675,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', - 'title' => '修改小版本升级类型', - ], - 'DescribeSlowLogTrend' => [ - 'methods' => [ - 'post', - 'get', - 'put', + 'title' => '修改实例集群可维护时间段', + 'summary' => '修改指定云数据库ClickHouse集群的可维护时间段。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterMaintainTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyDBConfig' => [ + 'summary' => '调用ModifyDBConfig接口修改社区兼容版集群的字典配置信息。', + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9301,253 +7725,103 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19458', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseLESIXD', - ], + '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', - ], + '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', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1r59y779o04****'], ], [ - 'name' => 'QueryDurationMs', + 'name' => 'Config', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL的执行耗时。最小值为**1000**，默认值为**1000**。单位：毫秒。返回参数将返回超过该耗时的慢SQL。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9999999999', - 'minimum' => '0', - 'example' => '1000', - 'isFileTransferUrl' => false, - 'default' => '1000', - ], + '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' => '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', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'BF3844B6-1B12-57A0-A259-476D2079EE83'], ], ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], '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', + 'title' => '修改字典配置信息', + 'description' => '><notice>此API仅适用于内核版本等于或低于20.8的集群。></notice>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'ModifyMinorVersionGreadeType' => [ + 'summary' => '修改ClickHouse小版本升级类型（自动升级或手动升级）。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '19444', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'update', + 'abilityTreeCode' => '147864', + 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + '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' => [ @@ -9555,107 +7829,182 @@ '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', - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], + 'description' => '', ], ], ], - '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', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], + 'title' => '修改小版本升级类型', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyMinorVersionGreadeType'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyMinorVersionGreadeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', + ], + 'ModifyRDSToClickhouseDb' => [ + 'summary' => '调用ModifyRDSToClickhouseDb接口修改云数据库ClickHouse社区兼容版集群的同步任务。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '143538', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZHDS8I', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '47742', + 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ - 'name' => 'DBClusterId', + 'name' => 'DbClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。您可以通过调用[DescribeDBClusters](~~170879~~)集群ID。'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc-uf6bnitmve5n0****', - ], + 'schema' => ['description' => '云数据库ClickHouse的集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp158i5wvj436****'], ], [ - 'name' => 'Product', + 'name' => 'ClickhousePort', 'in' => 'query', - 'schema' => [ - 'description' => '产品code。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + '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' => '返回参数。', + 'description' => '返回的结果。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', - ], + '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.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], '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', + 'title' => '修改同步任务', + 'description' => '>该接口仅适用于云数据库ClickHouse的社区兼容版集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyRDSToClickhouseDb'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyRDSToClickhouseDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'ReleaseClusterPublicConnection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9664,311 +8013,236 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '142683', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZHDS8I', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '19472', + 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], + 'tenantRelevance' => 'tenant', ], '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', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], ], '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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], + 'description' => '', ], ], ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], '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', + 'title' => '释放集群的公网连接地址', + 'summary' => '释放指定云数据库ClickHouse集群的公网连接地址。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReleaseClusterPublicConnection'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ReleaseClusterPublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'ResetAccountPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '163948', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '19473', + 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ResourceId', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '资源Id', - 'description' => '资源Id', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1i43033051****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'ResourceRegionId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'title' => '地域Id', - 'description' => '地域Id', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'AccountPassword', 'in' => 'query', - 'schema' => [ - 'title' => '目标资源组', - 'description' => '目标资源组', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-4690g37929****', - ], + 'schema' => ['description' => '数据库账号的新密码。'."\n" + .'>- 由大写字母、小写字母、数字、特殊字符中的任意三种组成。'."\n" + .'- 特殊字符为!@#$%^&*()_+-='."\n" + .'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456Ff'], ], ], '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', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], + 'description' => '', ], ], ], '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', - ], + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], ], ], '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', + 'title' => '重置账号密码', + 'summary' => '重置指定云数据库ClickHouse集群的指定数据库账号密码。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ResetAccountPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + '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":""}]', + ], + 'RestartInstance' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '173004', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], + 'abilityTreeCode' => '38056', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + '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-bp1t9lbb7a4z7****', - ], + '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', - ], + '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', - ], + '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', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => '预约重启的时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'>当该参数为空或填写早于当前时间时，集群将立即进行重启。', 'type' => 'string', 'required' => false, 'example' => '2023-03-22T00:00:50Z'], ], ], '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' => 'F5178C10-1407-4987-9133-DE4DC9119F34', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], ], 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', - ], + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], ], ], - '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', + 'title' => '重启集群', + 'summary' => '调用RestartInstance接口重启指定云数据库ClickHouse集群。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:RestartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'RestartInstanceNodeList' => [ + 'summary' => '批量重启ClickHouse社区兼容版实例节点', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9980,123 +8254,88 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '166003', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '173004', + 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceId', + 'name' => 'DBClusterId', '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, - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'ResourceType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型。取值为**DBCLUSTER**。', - 'type' => 'string', - 'required' => true, - 'example' => 'DBCLUSTER', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'All', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '是否删除集群的全部标签。取值说明：'."\n" - ."\n" - .' - **true**'."\n" - ."\n" - .'- **false**（默认值）'."\n" - ."\n" - .'>当参数**TagKey.N**为空时，该参数有效。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'TagKey', + 'name' => 'RestartTime', 'in' => 'query', - 'style' => 'repeatList', + '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' => '标签键。', + 'description' => '预约重启的节点列表。', 'type' => 'array', - 'items' => [ - 'description' => '标签键。支持删除N个标签键，N为整数且取值范围为**1~20**。', - 'type' => 'string', - 'required' => false, - 'example' => 'testkey1', - ], + 'items' => ['description' => '预约重启的节点名称。', 'type' => 'string', 'required' => false, 'example' => 'ck-uf6*****-2**-clickhouse-s-0-r-0'], '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', - ], + '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.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], '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集群上解绑', + 'title' => '批量重启实例节点', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36E3AB2E-E0DA-5C7B-8E29-89EE44926515\\"\\n}","type":"json"}]', ], 'TagResources' => [ - 'summary' => '为云数据库ClickHouse集群创建并绑定标签。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10109,22 +8348,14 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '166002', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceId', @@ -10133,15 +8364,10 @@ '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****', - ], + '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, ], @@ -10149,12 +8375,7 @@ [ 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型。唯一取值为**DBCLUSTER**。', - 'type' => 'string', - 'required' => true, - 'example' => 'DBCLUSTER', - ], + 'schema' => ['description' => '资源类型。唯一取值为**DBCLUSTER**。', 'type' => 'string', 'required' => true, 'example' => 'DBCLUSTER'], ], [ 'name' => 'Tag', @@ -10167,18 +8388,8 @@ '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', - ], + '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, ], @@ -10195,12 +8406,7 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '863D51B7-5321-41D8-A0B6-A088B0450EFD', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '863D51B7-5321-41D8-A0B6-A088B0450EFD'], ], ], ], @@ -10209,19 +8415,18 @@ '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', + 'summary' => '为云数据库ClickHouse集群创建并绑定标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + '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":""}]', + ], + 'TransferVersion' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10230,232 +8435,77 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '166149', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '36417', + 'abilityTreeNodes' => ['FEATUREclickhouse07PB80'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceType', + 'name' => 'DBClusterId', 'in' => 'query', - 'schema' => [ - 'description' => '资源类型。取值为**DBCLUSTER**。', - 'type' => 'string', - 'required' => true, - 'example' => 'DBCLUSTER', - ], + 'schema' => ['description' => '源集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1tm8zf130ew****'], ], [ - 'name' => 'NextToken', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '用来返回更多结果。第一次查询不需要提供这个参数，如果一次查询没有返回全部结果，则可在后续查询中传入前一次返回的NextToken继续查询。', - 'type' => 'string', - 'required' => false, - 'example' => '212db86sca4384811e0b5e8707ec21345', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + ."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], ], [ - 'name' => 'ResourceId', + 'name' => 'PageNumber', '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, - ], + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'Tag', + 'name' => 'TargetDbClusterId', '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, - ], + 'schema' => ['description' => '目标集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp14b39djx7zg****'], ], - ], - '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****', - ], - ], - ], - ], - ], - ], + [ + 'name' => 'SourceAccount', + 'in' => 'query', + 'schema' => ['description' => '源账号。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], - ], - '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' => [], + 'name' => 'TargetAccount', + 'in' => 'query', + 'schema' => ['description' => '目标账号。', 'type' => 'string', 'required' => true, 'example' => 'test01'], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '173183', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseYFBZ0B', + [ + 'name' => 'SourcePassword', + 'in' => 'query', + 'schema' => ['description' => '源账号密码。', 'type' => 'string', 'required' => true, 'example' => '123456Aa'], ], - ], - 'parameters' => [ [ - 'name' => 'MaxResults', + 'name' => 'TargetPassword', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '本次读取的最大数据记录数量', - 'description' => '每页记录数。取值为**1~100**，默认值为**30**。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '目标账号密码。', 'type' => 'string', 'required' => true, 'example' => '123456Ff'], ], [ - 'name' => 'ClientToken', + 'name' => 'DisableWriteWindows', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '幂等参数', - 'description' => '用于保证请求的幂等性。字符串格式，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', - 'type' => 'string', - 'required' => false, - 'example' => 'ETnLKlblzczshOTUbOCz****', - ], + 'schema' => ['description' => '停写窗口。', 'type' => 'string', 'required' => false, 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00'], ], [ - 'name' => 'DBClusterId', + 'name' => 'SourceClusterName', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'>您可以通过调用[DescribeDBClusters](~~170879~~)接口查询目标地域下所有的集群信息，包括集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp1t9lbb7a4z7****', - ], + 'schema' => ['description' => '自建ClickHouse集群的cluster名称。'."\n" + .'可通过执行`SELECT * FROM system.clusters`获取。', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ - 'name' => 'Product', + 'name' => 'SourceShards', 'in' => 'query', - 'schema' => [ - 'description' => '产品名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + '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' => [ @@ -10463,386 +8513,189 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F34', - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '7084CDB5-308F-5D0B-8F9B-5F7D83E09738'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统内部错误，请稍后重试'], + ], + 503 => [ + ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => '系统暂时不可用，请稍后重试'], + ], ], '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', + 'title' => '迁移版本', + 'summary' => '迁移版本。', + 'description' => '## 前提条件'."\n" + ."\n" + .'- 将源集群的IP地址添加到目标集群的白名单中。'."\n" + .'- 将目标集群的IP地址添加到源集群的白名单中。'."\n" + ."\n" + .'> 您可以通过`select * from system.clusters;`查看云数据库ClickHouse集群的IP地址。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:TransferVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], + ], ], + '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":""}]', + ], + 'UntagResources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '201218', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', - ], - 'tenantRelevance' => 'publicInformation', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '166003', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ - 'name' => 'Ids', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '运维任务ID，多个ID间使用英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '188****,188****,188****', - ], + 'schema' => ['description' => '地域ID。'."\n" + .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SwitchTime', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '后台发起切换操作的时间点，为 UTC 时间，格式为 YYYY-MM-DDTHH:mm:ssZ。', - 'type' => 'string', + '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, - 'docRequired' => true, - 'example' => '2023-01-09T05:00:00Z', + 'maxItems' => 51, ], ], [ - 'name' => 'ImmediateStart', + 'name' => 'ResourceType', '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', + 'schema' => ['description' => '资源类型。取值为**DBCLUSTER**。', 'type' => 'string', 'required' => true, 'example' => 'DBCLUSTER'], ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'All', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '是否删除集群的全部标签。取值说明：'."\n" + ."\n" + .' - **true**'."\n" + ."\n" + .'- **false**（默认值）'."\n" + ."\n" + .'>当参数**TagKey.N**为空时，该参数有效。', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'SourceCode', + 'name' => 'TagKey', 'in' => 'query', - 'allowEmptyValue' => false, + 'style' => 'repeatList', 'schema' => [ - 'description' => '运维事件类型代码，多个英文逗号分隔', - 'type' => 'string', + 'description' => '标签键。', + 'type' => 'array', + 'items' => ['description' => '标签键。支持删除N个标签键，N为整数且取值范围为**1~20**。', 'type' => 'string', 'required' => false, 'example' => 'testkey1'], 'required' => false, - 'docRequired' => false, - 'example' => 'Event.EventCode', + 'maxItems' => 21, ], ], ], 'responses' => [ 200 => [ + 'headers' => [], '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'ABC71772-F3A1-59CA-B811-4A5B0E0B72F8'], ], ], ], ], - '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', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => '将标签从ClickHouse集群上解绑', + 'summary' => '解绑云数据库ClickHouse集群的标签。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + '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":""}]', + ], + 'UpgradeMinorVersion' => [ + 'summary' => '调用UpgradeMinorVersion接口升级指定云数据库ClickHouse社区兼容版集群的内核小版本。', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '201217', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '147860', + 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'], ], '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', + 'name' => 'DBClusterId', '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', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****'], ], [ - 'name' => 'InsName', + 'name' => 'UpgradeImmediately', 'in' => 'query', - 'schema' => [ - 'description' => '实例名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp191w*******', - ], + 'schema' => ['description' => '是否立即升级，取值说明：'."\n" + ."\n" + .'- **true**：立即升级。'."\n" + ."\n" + .'- **false**：指定时间升级或可维护时间升级。'."\n" + ."\n" + .'>如果是指定时间升级内核小版本，那么**UpgradeTime**为必填项。'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false'], ], [ - 'name' => 'AllowChange', + 'name' => 'UpgradeVersion', 'in' => 'query', - 'schema' => [ - 'description' => '是否允许修改时间，取值：'."\n" - ."\n" - .'- **0**：不允许。'."\n" - .'- **1**：允许。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '-1', - ], + 'schema' => ['description' => '升级的内核小版本号。'."\n" + .'> 默认不填写，直接升级到最新的内核小版本。', 'type' => 'string', 'required' => false, 'example' => '1.37.0'], ], [ - 'name' => 'AllowCancel', - 'in' => 'query', - 'schema' => [ - 'description' => '是否允许取消，取值：'."\n" - ."\n" - .'- **0**：不允许。'."\n" - .'- **1**：允许。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '-1', - ], - ], - [ - 'name' => 'ChangeLevel', + 'name' => 'UpgradeTime', 'in' => 'query', - 'schema' => [ - 'description' => '任务级别。取值范围如下：'."\n" - ."\n" - .'- **all**（默认）：全部。'."\n" - .'- **S0**：返回异常修复级别的任务。'."\n" - .'- **S1**：返回系统运维级别的任务。', - 'type' => 'string', - 'required' => false, - 'example' => 'all', - ], + 'schema' => ['description' => '指定的升级时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" + .'>当不填写该参数时，则云数据库ClickHouse集群将在可维护时间内进行内核小版本升级。', 'type' => 'string', 'required' => false, 'example' => '2022-08-07T16:38Z'], ], ], 'responses' => [ @@ -10850,1682 +8703,1218 @@ '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" - .'}', - ], - ], - ], - ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7'], ], + 'description' => '', ], ], ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ], + ], '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', + 'title' => '升级内核小版本', + 'description' => '>仅2021年12月01日之后购买的社区兼容版集群支持升级内核小版本。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeMinorVersion'], ], - 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ + 'ramActions' => [ [ - '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', - ], + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:UpgradeMinorVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Ids\\": \\"188****,188****,188****\\\\n\\",\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\"\\n}","type":"json"}]', - 'title' => '取消尚未开始的运维任务', + '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":""}]', ], - 'DescribeActiveOperationMaintainConf' => [ - 'summary' => '查询Clickhouse实例的主动运维配置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + ], + 'endpoints' => [ + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-qingdao.aliyuncs.com', 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-hongkong.aliyuncs.com', 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-northeast-1.aliyuncs.com', 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-chengdu.aliyuncs.com', 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-southeast-1.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-southeast-5.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-southeast-6.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.us-east-1.aliyuncs.com', 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.eu-west-1.aliyuncs.com', 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.us-west-1.aliyuncs.com', 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.eu-central-1.aliyuncs.com', 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'clickhouse.me-central-1.aliyuncs.com', 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'Account is not found.', 'http_code' => 404, 'description' => '未找到对应账号。'], + ['code' => 'ACTION_UNAUTHORIZED', 'message' => 'The account balance is insufficient, and the opening of the public network needs to rely on load balancing service, which requires that the account balance must be greater than 100 yuan.', 'http_code' => 403, 'description' => '账户余额不足，开通公网需要依赖负载均衡服务，要求账户余额必须大于100元人民币'], + ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Invalid component for commodity.', 'http_code' => 500, 'description' => '订单配置参数不符合校验条件，请重新选配商品。'], + ['code' => 'DescribeLorneLogException', 'message' => 'Cannot find taskDetail in Lorne.', 'http_code' => 500, 'description' => '未找到对应SLS的任务详情。'], + ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => '账户未被授予操作资源的权限'], + ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => '资源不足。'], + ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => '系统内部错误，请稍后重试'], + ['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '该请求出现系统内部错误。'], + ['code' => 'InvalidAccountName.NotFound', 'message' => 'Specified account name does not exist.', 'http_code' => 404, 'description' => '指定的账号名称不存在。'], + ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter "BackupRetentionPeriod" is not valid.', 'http_code' => 400, 'description' => '请求参数 “BackupRetentionPeriod” 不合法。'], + ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '传入的实例ID不存在。'], + ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '传入的实例ID不存在。'], + ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => '未找到有效实例'], + ['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter "PageNumber" is not valid.', 'http_code' => 400, 'description' => '指定的参数“ PageNumber”无效。'], + ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter "PageSize" is not valid.', 'http_code' => 400, 'description' => '指定的参数“ PageSize”无效。'], + ['code' => 'InvalidParameter.DBClusterVersion', 'message' => 'The version is invalid. Check whether the DBClusterVersion, MinorVersion, and MajorVersion parameters are correct.', 'http_code' => 400, 'description' => '版本参数不合法，请检查DBClusterVersion、MinorVersion、MajorVersion参数是否正确'], + ['code' => 'InvalidParameter.DBNodeStorage', 'message' => 'The specified parameter "DBNodeStorage" is not valid.', 'http_code' => 400, 'description' => '指定的参数"DBNodeStorage"无效。'], + ['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter "RegionId" is not valid.', 'http_code' => 400, 'description' => '指定的参数“ RegionId”无效。'], + ['code' => 'InvalidSecurityIPs.Exceeded', 'message' => 'The specified parameter "SecurityIps" count is exceeded 200.', 'http_code' => 400, 'description' => '安全组IP数总量超过200。'], + ['code' => 'InvalidVPC.NotFound', 'message' => 'VPC or VSwitch is not valid.', 'http_code' => 404, 'description' => '传入的VPC ID不存在。'], + ['code' => 'InvalidVpcId.Malformed', 'message' => 'The specified parameter "VpcId" is not valid.', 'http_code' => 400, 'description' => '参数"VpcId"无效'], + ['code' => 'ModifyServerConfigFailed', 'message' => 'Failed to modify server config.', 'http_code' => 500, 'description' => '修改实例配置失败。'], + ['code' => 'OperationDenied.CKNotConnected', 'message' => 'Connect to ClickHouse Cluster Failed.', 'http_code' => 403, 'description' => '连接CK失败，请检查CK状态、白名单及连通性。'], + ['code' => 'OperationDenied.VirtualWarehouseShardsAlign', 'message' => 'The operation is not permitted due to virtualWarehouse shards align.', 'http_code' => 403, 'description' => '由于实例分片对齐，不允许该操作。'], + ['code' => 'PRICE.PRICING_PLAN_RESULT_NOT_FOUND', 'message' => 'Cannot find pricing plan for the commodity.', 'http_code' => 500, 'description' => '定价计划价格结果没有找到。'], + ['code' => 'ServiceUnavailable', 'message' => 'An error occurred while processing your request.', 'http_code' => 503, 'description' => '系统暂时不可用，请稍后重试'], + ['code' => 'UNAVAILABLE', 'message' => 'Service Unavailable.', 'http_code' => 502, 'description' => '服务不可用。'], + ['code' => 'UNKNOWN', 'message' => 'Unknown error.', 'http_code' => 500, 'description' => '未知错误。'], + ['code' => 'UserNotInBuyWhiteList', 'message' => 'ClickHouse is at the canary release stage. Please apply for use by submitting a ticket.', 'http_code' => 500, 'description' => 'ClickHouse 目前在灰度阶段，请提工单申请'], + ['code' => 'InvalidSpecification', 'message' => 'Specification parameter is not valid.', 'http_code' => 400, 'description' => '规格参数无效。'], + ['code' => 'InvalidDBInstanceStatus', 'message' => 'The specified instance state does\'t support this operation.', 'http_code' => 400, 'description' => '实例状态不允许当前操作。'], + ['code' => 'OperationDenied.OrderProcessing', 'message' => 'The operation is not permitted due to there is an order in processing of cluster.', 'http_code' => 400, 'description' => '存在未完成的订单，请稍后再试。'], + ['code' => 'OperationDenied.NothingChanged', 'message' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.', 'http_code' => 400, 'description' => '实例操作变更配置，但传入配置与当前配置相同，没有任何改变。'], + ['code' => 'StorageTypeDoNotSupportBackup', 'message' => 'Current StorageType Does Not Support Backup.', 'http_code' => 400, 'description' => '当前存储类型不支持备份'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSynDbTables'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateMonitorDataReport'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckClickhouseToRDS'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePortsForClickHouse'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckMonitorAlert'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBCluster'], + ['threshold' => '8', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSQLAccount'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReleaseClusterPublicConnection'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountAuthority'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSynDbs'], + ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], + ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackupPolicy'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], + ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAccessWhiteList'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAccount'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSyndb'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAccountPassword'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccounts'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRDSToClickhouseDb'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeMinorVersion'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'AllocateClusterPublicConnection'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterNetInfoItems'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyMinorVersionGreadeType'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAccessWhiteList'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyRDSToClickhouseDb'], + ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccountAndAuthority'], + ], + ], + 'ram' => [ + 'productCode' => 'ClickHouse', + 'productName' => '云数据库 ClickHouse ', + 'ramCodes' => ['clickhouse'], + 'ramLevel' => '资源级', + 'ramConditions' => [ + [ + 'name' => 'clickhouse:EncryptionType', + 'schema' => ['type' => 'Array<String>', 'description' => '加密类型'], ], - 'security' => [ - [ - 'AK' => [], + ], + 'ramActions' => [ + [ + 'apiName' => 'ModifyActiveOperationMaintainConf', + 'description' => '修改主动运维事件', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyActiveOperationMaintainConf', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeAutoRenewAttribute', + 'description' => '查询ClickHouse社区兼容版实例自动续费信息', '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', - ], - ], - ], - ], + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAutoRenewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => [], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '修改ClickHouse社区兼容版集群所在资源组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'systemTags' => [ - 'operationType' => 'none', - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'CycleType', - 'in' => 'query', - 'schema' => [ - 'description' => '周期类型。'."\n" - ."\n" - .'- Month 每月'."\n" - .'- Week 每周', - 'type' => 'string', - 'required' => false, - 'example' => 'Week', + [ + 'apiName' => 'DescribeColumns', + 'description' => '查看列', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeColumns', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'CycleTime', - 'in' => 'query', - 'schema' => [ - 'description' => '周期时间。'."\n" - ."\n" - .'- 当CycleType为Month，返回1～28的数字，表示每月几号，用","拼接。'."\n" - .'- 当CycleType为Week，返回1～7的数字，表示每周星期几，用","拼接。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeSynDbTables', + 'description' => '查看同步数据库与表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSynDbTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'MaintainStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '任务开始时间。格式为[unk]yyyy-mm-ddthh:mm:ssz[unk]（utc时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '07:00Z', + ], + [ + 'apiName' => 'RestartInstance', + 'description' => '重启集群', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:RestartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'MaintainEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '可维护时间段的结束时间。格式为[unk]hh:mmz-hh:mmz[unk]（utc 时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '20:00Z', + ], + [ + 'apiName' => 'DeleteDBCluster', + 'description' => '删除集群', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteDBCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '是否生效，取值说明：'."\n" - ."\n" - .'- **1**：是。'."\n" - .'- **2**：否。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '1', - 'enum' => [ - '1', - '2', - ], + ], + [ + 'apiName' => 'ModifyBackupPolicy', + 'description' => '修改备份策略', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', - ], - ], + [ + 'apiName' => 'DeleteSyndb', + 'description' => '删除同步任务', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteSyndb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => [], + [ + 'apiName' => 'DeleteSLB', + 'description' => 'DeleteSLB', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteSLB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CheckScaleOutBalanced', + 'description' => '扩容检查', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '209424', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', + 'ramAction' => [ + 'action' => 'clickhouse:CheckScaleOutBalanced', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', + [ + 'apiName' => 'DeleteBackupPolicy', + 'description' => '删除备份策略', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DBClusterIds', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-uf6g4417bo*****', + ], + [ + 'apiName' => 'DescribeSynDbs', + 'description' => '查看同步db', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSynDbs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', + ], + [ + 'apiName' => 'ModifyMinorVersionGreadeType', + 'description' => '修改小版本升级类型', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyMinorVersionGreadeType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '重置账号密码', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ResetAccountPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ModifyDBClusterAccessWhiteList', + 'description' => '修改白名单', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterAccessWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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' => [], + [ + 'apiName' => 'DescribeAccounts', + 'description' => '查询账号信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccounts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ModifyDBConfig', + 'description' => '修改字典配置信息', 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'paid', - ], - 'parameters' => [ - [ - 'name' => 'DBClusterIds', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。'."\n" - .'如果有多个集群ID，以英文逗号（,）分隔。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1uy5ff6*****', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - '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', + ], + [ + 'apiName' => 'DescribeUserEncryptionKeyList', + 'description' => '查看KMS密钥列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeUserEncryptionKeyList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - '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', + ], + [ + 'apiName' => 'CancelActiveOperationTasks', + 'description' => '取消尚未开始的运维任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:CancelActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PeriodUnit', - 'in' => 'query', - 'schema' => [ - 'description' => '续费时长的时间单位，即参数Duration的单位。取值范围：Month，Year', - 'type' => 'string', - 'required' => false, - 'example' => 'Year', - 'default' => 'Month', + ], + [ + 'apiName' => 'DescribeSlowLogRecords', + 'description' => '查看慢日志明细', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7B94AB34-6875-56D2-92B4-0C2******', - ], - ], + [ + 'apiName' => 'DescribeTransferHistory', + 'description' => '查看迁移记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeTransferHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBCluster.NotFound', - 'errorMessage' => 'The DBClusterId provided does not exist in our records.', + [ + 'apiName' => 'CreateAccount', + 'description' => '创建账号', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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' => [], + [ + 'apiName' => 'DescribeAllDataSource', + 'description' => '枚举数据库列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAllDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeAccountAuthority', + 'description' => '查看账号权限', 'operationType' => 'get', - 'abilityTreeCode' => '220406', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseY04H6E', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeActiveOperationMaintainConf', + 'description' => '查询主动运维配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeActiveOperationMaintainConf', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '当前页码。', - 'type' => 'string', - 'required' => false, - 'example' => '1', + ], + [ + 'apiName' => 'CreateServiceLinkedRole', + 'description' => '创建服务关联角色', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**', - 'type' => 'string', - 'required' => false, - 'example' => '30', + ], + [ + 'apiName' => 'ModifyDBClusterDescription', + 'description' => '修改集群名称', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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", - ], - ], - ], - ], - ], + [ + 'apiName' => 'ReleaseClusterPublicConnection', + 'description' => '释放集群的公网连接地址', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ReleaseClusterPublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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' => [], + [ + 'apiName' => 'CreatePortsForClickHouse', + 'description' => '新增端口', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreatePortsForClickHouse', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '173004', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', + [ + 'apiName' => 'CheckServiceLinkedRole', + 'description' => '查新服务关联角色（SLR）', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckServiceLinkedRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。'."\n" - .'>您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'CheckClickhouseToRDS', + 'description' => '检查与RDS连通性', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckClickhouseToRDS', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', + ], + [ + 'apiName' => 'CreateSLB', + 'description' => 'CreateSLB', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateSLB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', + ], + [ + 'apiName' => 'DescribeDBClusterConfigInXML', + 'description' => '查询XML模式下的配置参数', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterConfigInXML', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'CreateOSSStorage', + 'description' => '创建冷存储', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateOSSStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DisableWrite', - 'in' => 'query', - 'schema' => [ - 'description' => '是否停写。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'DescribeDBClusterPerformance', + 'description' => '查看性能数据', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterPerformance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'ElectTime', - 'in' => 'query', - 'schema' => [ - 'description' => '切主时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2025-12-12T07:28:00Z', + ], + [ + 'apiName' => 'CreateSQLAccount', + 'description' => '创建高权限账号或普通账号', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateSQLAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'KillProcess', + 'description' => '终止正在进行的任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:KillProcess', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + [ + 'apiName' => 'DescribeSchemas', + 'description' => '枚举实例下所有数据库列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', + ], + [ + 'apiName' => 'DescribeBackups', + 'description' => '查看备份集', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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' => [], + [ + 'apiName' => 'ModifyRDSToClickhouseDb', + 'description' => '修改同步任务', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyRDSToClickhouseDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeProcessList', + 'description' => '查看实例正在运行的查询', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '173004', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseMCDGZK', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeProcessList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ModifyDBClusterMaintainTime', + 'description' => '修改实例集群可维护时间段', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterMaintainTime', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', + ], + [ + 'apiName' => 'ModifyDBCluster', + 'description' => '对集群进行升降配', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', + ], + [ + 'apiName' => 'DescribeOSSStorage', + 'description' => '查看冷存', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeOSSStorage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'UntagResources', + 'description' => '将标签从ClickHouse集群上解绑', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:UntagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'ModifyActiveOperationTasks', + 'description' => '修改实例计划内运维事件的切换时间', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyActiveOperationTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + [ + 'apiName' => 'CheckModifyConfigNeedRestart', + 'description' => '查询配置参数是否需要重启', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckModifyConfigNeedRestart', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', + ], + [ + 'apiName' => 'CreateAccountAndAuthority', + 'description' => '创建账号及权限', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateAccountAndAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}'], ], ], ], - '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' => [], + [ + 'apiName' => 'CancelRestartInstance', + 'description' => 'CancelRestartInstance', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:CancelRestartInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'RestartInstanceNodeList', + 'description' => '批量重启实例节点', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '173004', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', + 'ramAction' => [ + 'action' => 'clickhouse:RestartInstanceNodeList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'CreateDBInstance', + 'description' => '创建集群', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', + ], + [ + 'apiName' => 'DeleteAccount', + 'description' => '删除账号', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- 30（默认值）'."\n" - .'- 50'."\n" - .'- 100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', + ], + [ + 'apiName' => 'DescribeTables', + 'description' => '查看表信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'DescribeDBClusterAttribute', + 'description' => '查看集群的详细属性', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'ListTagResources', + 'description' => '查询实例绑定的标签列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'clickhouse:ListTagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + [ + 'apiName' => 'DescribeDBClusterNodeInfos', + 'description' => '获取实例节点信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterNodeInfos', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', + ], + [ + 'apiName' => 'DescribeActiveOperationTasks', + 'description' => '查询实例的运维事件详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeActiveOperationTasks', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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' => [], + [ + 'apiName' => 'CheckMonitorAlert', + 'description' => '是否开通监控告警功能', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:CheckMonitorAlert', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '173004', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', + [ + 'apiName' => 'DescribeAllDataSources', + 'description' => '查看数据源', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAllDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeDBClusterConfig', + 'description' => '查看集群参数配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', + ], + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '查看备份策略', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - ."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', + ], + [ + 'apiName' => 'DescribeDBClusters', + 'description' => '查询集群列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusters', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'ModifyAccountDescription', + 'description' => '修改账号的备注信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'RestartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '预约重启的时间。格式：yyyy-MM-ddTHH:mmZ（UTC时间）。'."\n" - .'>当该参数为空或填写早于当前时间时，集群将立即进行重启。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-03-22T00:00:50Z', + ], + [ + 'apiName' => 'TagResources', + 'description' => '为ClickHouse集群添加标签', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:TagResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - '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, + ], + [ + 'apiName' => 'DescribeDBConfig', + 'description' => '查询字典配置信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'CreateRDSToClickhouseDb', + 'description' => '创建同步任务', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateRDSToClickhouseDb', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + [ + 'apiName' => 'CreateBackupPolicy', + 'description' => '创建备份策略', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', + ], + [ + 'apiName' => 'AllocateClusterPublicConnection', + 'description' => '对集群开通公网', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:AllocateClusterPublicConnection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - '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', + [ + 'apiName' => 'ModifyDBClusterConfig', + 'description' => '修改集群配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateMonitorDataReport', + 'description' => '创建监控数据报告', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateMonitorDataReport', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpgradeMinorVersion', + 'description' => '升级内核小版本', 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '173004', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseXSQ0JG', + 'ramAction' => [ + 'action' => 'clickhouse:UpgradeMinorVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '实例所属地域的ID。', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ModifyAutoRenewAttribute', + 'description' => '修改ClickHouse社区兼容版集群自动续费状态', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAutoRenewAttribute', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'DBClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc-bp108z124a8o7****', + ], + [ + 'apiName' => 'ModifyDBClusterConfigInXML', + 'description' => '变更配置参数', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBClusterConfigInXML', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- 30（默认值）'."\n" - .'- 50'."\n" - .'- 100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', + ], + [ + 'apiName' => 'DescribeSlowLogTrend', + 'description' => '查看集群慢日志趋势统计情况', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', + ], + [ + 'apiName' => 'ModifyAccountAuthority', + 'description' => '修改账号权限', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], - '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', - ], - ], + [ + 'apiName' => 'DescribeConfigVersionDifference', + 'description' => '查看配置参数变更前后的参数值', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeConfigVersionDifference', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'An error occurred while processing your request.', + [ + 'apiName' => 'DescribeDBClusterAccessWhiteList', + 'description' => '查看集群的IP白名单', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterAccessWhiteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], - 503 => [ - [ - 'errorCode' => 'ServiceUnavailable', - 'errorMessage' => 'An error occurred while processing your request.', + ], + [ + 'apiName' => 'DescribeConfigHistory', + 'description' => '查看配置参数的变更记录', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeConfigHistory', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DescribeDBClusterNetInfoItems', + 'description' => '查看网络信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBClusterNetInfoItems', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + [ + 'apiName' => 'TransferVersion', + 'description' => '迁移版本', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:TransferVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ], + ], ], - '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', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], + ['validationType' => 'always', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/*'], ], ], ]; diff --git a/data/zh_cn/clickhouse/2023-05-22/api-docs.php b/data/zh_cn/clickhouse/2023-05-22/api-docs.php index 59668a4..afd813f 100644 --- a/data/zh_cn/clickhouse/2023-05-22/api-docs.php +++ b/data/zh_cn/clickhouse/2023-05-22/api-docs.php @@ -1,137 +1,180 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'clickhouse', - 'version' => '2023-05-22', - ], + 'info' => ['style' => 'RPC', 'product' => 'clickhouse', 'version' => '2023-05-22'], 'directories' => [ [ - 'id' => 222452, - 'title' => '集群管理', - 'type' => 'directory', - 'children' => [ - 'CreateDBInstance', - 'DeleteDBInstance', - 'StartDBInstance', - 'RestartDBInstance', - 'StopDBInstance', - 'ModifyDBInstanceClass', - 'ModifyDBInstanceAttribute', - 'DescribeDBInstances', - 'DescribeDBInstanceAttribute', - 'UpgradeMinorVersion', - ], - ], - [ - 'id' => 222463, - 'title' => '账号管理', + 'children' => ['CreateDB', 'DeleteDB', 'DescribeDBInstanceDataSources'], 'type' => 'directory', - 'children' => [ - 'CreateAccount', - 'DeleteAccount', - 'ResetAccountPassword', - 'ModifyAccountDescription', - 'ModifyAccountAuthority', - 'DescribeAccounts', - 'DescribeAccountAuthority', - ], - ], - [ - 'id' => 222471, 'title' => '数据库管理', - 'type' => 'directory', - 'children' => [ - 'CreateDB', - 'DeleteDB', - 'DescribeDBInstanceDataSources', - ], + 'id' => 2883, ], [ - 'id' => 222475, - 'title' => '网络管理', + 'children' => ['DescribeProcessList', 'KillProcess', 'DescribeSlowLogTrend'], 'type' => 'directory', - 'children' => [ - 'CreateEndpoint', - 'DeleteEndpoint', - 'ModifyDBInstanceConnectionString', - 'ModifySecurityIPList', - 'DescribeSecurityIPList', - 'DescribeEndpoints', - ], - ], - [ - 'id' => 222482, 'title' => '任务及日志管理', - 'type' => 'directory', - 'children' => [ - 'DescribeProcessList', - 'KillProcess', - 'DescribeSlowLogTrend', - 'DescribeSlowLogRecords', - ], + 'id' => 34386, ], [ - 'id' => 222487, - 'title' => '备份管理', - 'type' => 'directory', - 'children' => [ - 'ModifyBackupPolicy', - 'DescribeBackupPolicy', - 'DeleteBackupPolicy', - 'CreateBackupPolicy', - 'DescribeBackups', - ], - ], - [ - 'id' => 222493, - 'title' => '参数管理', - 'type' => 'directory', 'children' => [ - 'ModifyDBInstanceConfig', - 'DescribeDBInstanceConfigChangeLog', - 'DescribeDBInstanceConfig', + 'AttachWhitelistTemplateToInstance', 'ChangeResourceGroup', 'CreateAccount', 'CreateBackupPolicy', 'CreateDBInstance', 'CreateEndpoint', 'CreateLangfuseOrg', 'CreateLangfuseOrgMember', 'CreateLangfuseProject', 'CreateLangfuseUser', 'CreateWhitelistTemplate', 'DeleteAccount', 'DeleteBackupPolicy', 'DeleteDBInstance', 'DeleteEndpoint', 'DeleteLangfuseInstance', 'DeleteLangfuseOrg', 'DeleteLangfuseOrgMembership', 'DeleteLangfuseProject', 'DeleteLangfuseUser', + 'DeleteWhitelistTemplate', 'DescribeAccountAuthority', 'DescribeAccounts', 'DescribeBackupPolicy', 'DescribeBackups', 'DescribeDBInstanceAttribute', 'DescribeDBInstanceConfig', 'DescribeDBInstanceConfigChangeLog', 'DescribeDBInstances', 'DescribeEndpoints', 'DescribeLangfuseEndpoints', 'DescribeLangfuseOrgMemberships', 'DescribeLangfuseOrgs', 'DescribeLangfuseProjectMemberships', 'DescribeLangfuseProjects', 'DescribeLangfuseSecurityIPList', 'DescribeLangfuseUser', 'DescribeLangfuseUsers', 'DescribeRegions', 'DescribeSecurityIPList', + 'DescribeSlowLogRecords', 'DetachWhitelistTemplateToInstance', 'GetWhitelistTemplate', 'ListClickHouseDBTimezones', 'ListInstanceLinkedWhitelistTemplates', 'ListWhitelistTemplates', 'ModifyAccountAuthority', 'ModifyAccountDescription', 'ModifyBackupPolicy', 'ModifyDBInstanceAttribute', 'ModifyDBInstanceClass', 'ModifyDBInstanceConfig', 'ModifyDBInstanceConnectionString', 'ModifyLangfuseOrgMembership', 'ModifyLangfuseProjectMembership', 'ModifySecurityIPList', 'ResetAccountPassword', 'ResetLangfuseUserPassword', 'RestartDBInstance', 'StartDBInstance', + 'StopDBInstance', 'UpdateWhitelistTemplate', 'UpgradeMinorVersion', ], - ], - [ - 'id' => 222497, 'title' => '其他', 'type' => 'directory', - 'children' => [ - 'ChangeResourceGroup', - ], - ], - [ - 'id' => 0, - 'title' => '其它', - 'type' => 'directory', - 'children' => [ - 'ListClickHouseDBTimezones', - 'DeleteWhitelistTemplate', - 'CreateWhitelistTemplate', - 'DetachWhitelistTemplateToInstance', - 'UpdateWhitelistTemplate', - 'GetWhitelistTemplate', - 'AttachWhitelistTemplateToInstance', - 'ListWhitelistTemplates', - 'ListInstanceLinkedWhitelistTemplates', - ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'CreateDBInstance' => [ - 'summary' => '调用CreateDBInstance接口创建ClickHouse企业版集群。', - 'methods' => [ - 'get', - 'post', + 'AttachWhitelistTemplateToInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['title' => '白名单模板Id', 'description' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['title' => '数据库实例。逗号分隔，一次关联变更不超过20个', 'description' => '数据库实例。逗号分隔，一次关联变更不超过20个', 'type' => 'string', 'required' => true, 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890'], + 'Data' => [ + 'title' => '', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '操作状态。ok', 'description' => '操作状态。ok', 'type' => 'string', 'example' => 'ok'], + 'AttachFailList' => [ + 'title' => '解绑失败实例', + 'description' => '解绑失败实例', + 'type' => 'array', + 'items' => [ + 'title' => '实例解绑失败详情', + 'description' => '实例解绑失败详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'my-database'], + 'Reason' => ['title' => '解绑失败原因', 'description' => '解绑失败原因', 'type' => 'string', 'example' => '处理异常'], + ], + ], + ], + 'AttachSuccessedList' => [ + 'title' => '绑定成功模板', + 'description' => '绑定成功模板', + 'type' => 'array', + 'items' => [ + 'title' => '实例绑定成功详情', + 'description' => '实例绑定成功详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'my-database'], + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem'], + 'TemplateName' => ['title' => '白名单模板名称', 'description' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'description' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'description' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'asdfwef'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''], + ['errorCode' => 'InvalidDBInstanceId.TooManyItems', 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', 'description' => ''], + ['errorCode' => 'InvalidParameter.DBInstanceId', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', 'description' => ''], + ['errorCode' => 'InvalidAttachTemplate.QuotaExceeded', 'errorMessage' => 'Exceed the upper limit of the template that the instance can bind.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], + 'title' => '白名单模板关联实例', + 'summary' => '白名单模板关联实例。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:AttachWhitelistTemplateToInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"AttachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"AttachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改ClickHouse企业版实例所在资源组。', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -140,115 +183,487 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '182031', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseN0HBPQ', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '163948', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'ResourceType', 'in' => 'query', - 'allowEmptyValue' => false, 'schema' => [ - 'title' => '幂等参数', - 'description' => '用于保证请求的幂等性，防止重复提交请求。'."\n" - .'该参数值由客户端生成，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', + 'title' => '资源类型', + 'description' => '资源类型', 'type' => 'string', 'required' => false, - 'example' => 'AB', + 'enumValueTitles' => [], + 'example' => 'EnterpriseDBCluster', + 'default' => 'EnterpriseDBCluster', ], ], [ - 'name' => 'RegionId', + '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' => '地域id', - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C342F3DD-1FF7-55E9-A1A1-098D*******'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''], + ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', 'description' => ''], + ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改ClickHouse企业版实例所在资源组', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098D*******\\"\\n}","type":"json"}]', + ], + 'CreateAccount' => [ + 'summary' => '调用CreateAccount接口为云数据库ClickHouse企业版集群创建数据库账号。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ZoneId', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185272', + 'abilityTreeNodes' => ['FEATUREclickhouseL1079N'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], + ], + [ + 'name' => 'AccountType', 'in' => 'query', 'schema' => [ - 'title' => '可用区', - 'description' => '可用区ID。', + 'description' => '数据库账号的类型，取值说明：'."\n" + .'- **NormalAccount**：普通账号。'."\n" + .'- **SuperAccount**：高权限账号。', 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', + 'required' => true, + 'example' => 'NormalAccount', + 'enum' => ['SuperAccount', 'NormalAccount'], ], ], [ - 'name' => 'VpcId', + 'name' => 'Account', 'in' => 'query', + 'schema' => ['description' => '数据库账号，设置规则如下。'."\n" + .'- 名称唯一。'."\n" + .'- 由小写字母、数字或下划线组成。'."\n" + .'- 以小写字母开头，以小写字母或数字结尾。'."\n" + .'- 长度为2~64个字符。', 'type' => 'string', 'required' => true, 'example' => 'test1'], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => '数据库账号密码，设置规则如下。'."\n" + ."\n" + .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" + ."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + ."\n" + .'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => 'a1b2c3d4@'], + ], + [ + 'name' => 'DmlAuthSetting', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'VPC ID。', - 'description' => 'VPC ID。', - 'type' => 'string', + 'description' => '授权信息。', + 'type' => 'object', + 'properties' => [ + 'DmlAuthority' => [ + 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" + .'- **0**：允许进行读取、写入和更改设置的查询'."\n" + .'- **1**：仅允许进行读取数据的查询。'."\n" + .'- **2**：允许进行读取数据和更改设置的查询。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => ['0', '1', '2'], + ], + 'DdlAuthority' => ['description' => '是否授予数据库账号DDL权限，取值如下：'."\n" + ."\n" + .'- **true**：允许DDL。'."\n" + .'- **false**：禁止DDL。', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'AllowDictionaries' => [ + 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', + 'type' => 'array', + 'items' => ['description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'dc1,dc2'], + 'required' => false, + ], + 'AllowDatabases' => [ + 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', + 'type' => 'array', + 'items' => ['description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'db1,db2'], + 'required' => false, + ], + ], 'required' => false, - 'example' => 'vpc-uf6xmupdn7v6ui9f****', ], ], [ - 'name' => 'VswitchId', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Product', 'in' => 'query', + 'schema' => ['description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => '备注说明。', 'type' => 'string', 'required' => false, 'example' => 'For testing'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '交换机ID。', - 'description' => '交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-uf632qye9oqt4x4sr****', + 'title' => 'Schema of Response', + 'description' => '返回结果详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA****'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Account' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'test1'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter "AccountType" is not valid.', 'description' => ''], + ['errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter "Account" is not valid.', 'description' => ''], + ['errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter "Password" is not valid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''], + ], [ - 'name' => 'DBInstanceDescription', + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => '创建账号', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'CreateBackupPolicy' => [ + 'summary' => '为指定的ClickHouse企业版集群创建备份策略。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-2ze0eb0w182xh8549'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => ['description' => '执行备份的`UTC`时间范围。'."\n" + .'例如`12:00Z-13:00Z`，则表示将在`UTC`时间的`12:00`到`13:00`之间开始执行备份。', 'type' => 'string', 'required' => true, 'example' => '10:00Z-11:00Z'], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => ['description' => '备份周期。'."\n" + .'指定每周备份日期，多个日期需用英文逗号`,`隔开。', 'type' => 'string', 'required' => true, 'example' => 'Monday,Friday'], + ], + [ + 'name' => 'BackupRetentionPeriod', 'in' => 'query', + 'schema' => ['description' => '备份保留天数。', 'type' => 'string', 'required' => false, 'example' => '8'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '集群说明。', - 'description' => '集群说明。', - 'type' => 'string', - 'required' => false, - 'example' => '集群测试', + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'StorageTypeDoNotSupportBackup', 'errorMessage' => 'Current StorageType Does Not Support Backup.', 'description' => '当前存储类型不支持备份'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建备份策略', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:CreateBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + ], + 'CreateDB' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EngineVersion', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185311', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => ['description' => '数据库名称。命名规则如下：'."\n" + .'- 由小写字母、数字、下划线（_）、中划线（-）组成。'."\n" + .'- 以小写字母开头，且以小写字母或数字结尾。'."\n" + .'- 长度最多为64个字符。'."\n" + ."\n" + .'><notice>下划线（_）会被看作两个字符。></notice>', 'type' => 'string', 'required' => true, 'example' => 'testdb001'], + ], + [ + 'name' => 'Comment', 'in' => 'query', + 'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '引擎版本。', - 'description' => '引擎版本。', - 'type' => 'string', - 'required' => false, - 'example' => '23.8', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb001'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建数据库', + 'summary' => '调用CreateDB接口创建数据库。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateDB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', + ], + 'CreateDBInstance' => [ + 'summary' => '调用CreateDBInstance接口创建ClickHouse企业版集群。', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '182031', + 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['title' => '幂等参数', 'description' => '用于保证请求的幂等性，防止重复提交请求。'."\n" + .'该参数值由客户端生成，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'AB'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域id', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => ['title' => '可用区', 'description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['title' => 'VPC ID。', 'description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6xmupdn7v6ui9f****'], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => ['title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf632qye9oqt4x4sr****'], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => ['title' => '集群说明。', 'description' => '集群说明。', 'type' => 'string', 'required' => false, 'example' => 'Cluster test'], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => ['title' => '引擎版本。', 'description' => '引擎版本。', 'type' => 'string', 'required' => false, 'example' => '23.8'], + ], [ 'name' => 'ScaleMin', 'in' => 'query', - 'schema' => [ - 'title' => 'serverless弹性伸缩最小值。', - 'description' => 'serverless弹性伸缩最小值。不推荐使用，当前建议使用NodeCount，NodeScaleMin，NodeScaleMax设置弹性能力。', - 'type' => 'string', - 'required' => false, - 'example' => '8', - ], + 'schema' => ['title' => 'serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。不推荐使用，当前建议使用NodeCount，NodeScaleMin，NodeScaleMax设置弹性能力。', 'type' => 'string', 'required' => false, 'example' => '8'], ], [ 'name' => 'ScaleMax', 'in' => 'query', - 'schema' => [ - 'title' => 'serverless弹性伸缩最大值。', - 'description' => 'serverless弹性伸缩最大值。不推荐使用，当前建议使用NodeCount，NodeScaleMin，NodeScaleMax设置弹性能力。', - 'type' => 'string', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['title' => 'serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。不推荐使用，当前建议使用NodeCount，NodeScaleMin，NodeScaleMax设置弹性能力。', 'type' => 'string', 'required' => false, 'example' => '32'], ], [ 'name' => 'Engine', @@ -259,9 +674,7 @@ 'type' => 'string', 'required' => false, 'example' => 'clickhouse', - 'enum' => [ - 'clickhouse', - ], + 'enum' => ['clickhouse'], ], ], [ @@ -277,24 +690,12 @@ 'description' => '多可用区配置。', 'type' => 'object', 'properties' => [ - 'ZoneId' => [ - 'title' => '可用区ID。', - 'description' => '可用区ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou-h', - ], + 'ZoneId' => ['title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h'], 'VSwitchIds' => [ 'title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'array', - 'items' => [ - 'title' => '交换机ID。', - 'description' => '交换机ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-8vb05l07h3sdayqhe****', - ], + 'items' => ['title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-8vb05l07h3sdayqhe****'], 'required' => false, ], ], @@ -306,139 +707,49 @@ [ 'name' => 'DeploySchema', 'in' => 'query', - 'schema' => [ - 'title' => '集群可用区部署状态。', - 'description' => '集群可用区部署状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'multi_az', - ], + 'schema' => ['title' => '集群可用区部署状态。', 'description' => '集群可用区部署状态。', 'type' => 'string', 'required' => false, 'example' => 'multi_az'], ], [ 'name' => 'SourceDBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群例ID。', - 'description' => '集群例ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-2ze1*********', - ], + 'schema' => ['title' => '集群例ID。', 'description' => '原集群实例ID。（使用备份恢复时）', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze1*********'], ], [ 'name' => 'BackupSetId', 'in' => 'query', - 'schema' => [ - 'title' => '备份集ID。', - 'description' => '备份集ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '备份集ID。', 'description' => '备份集ID。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '集群所属的资源组ID。', - 'description' => '集群资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-*****', - ], + 'schema' => ['title' => '集群所属的资源组ID。', 'description' => '集群资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-*****'], ], [ 'name' => 'NodeScaleMax', 'in' => 'query', - 'schema' => [ - 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', - 'description' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '128', - 'minimum' => '4', - 'example' => '4', - ], + 'schema' => ['title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'description' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '4'], ], [ 'name' => 'NodeScaleMin', 'in' => 'query', - 'schema' => [ - 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', - 'description' => 'serverless节点弹性伸缩最小值。取值范围4-32', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '128', - 'minimum' => '4', - 'example' => '32', - ], + 'schema' => ['title' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'description' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '32'], ], [ 'name' => 'NodeCount', 'in' => 'query', - 'schema' => [ - 'title' => '节点个数，取值范围2-16', - 'description' => '节点个数，取值范围2-16。使用NodeScaleMin、NodeScaleMax配置弹性区间时必填。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '64', - 'minimum' => '2', - 'example' => '2', - ], - ], - [ - 'name' => 'StorageQuota', - 'in' => 'query', - 'schema' => [ - 'title' => '存储预购量（GB）', - 'description' => '存储预购量（GB）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '100', - ], - ], - [ - 'name' => 'StorageType', - 'in' => 'query', - 'schema' => [ - 'title' => '存储类型。', - 'description' => '存储类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - 'enum' => [ - 'oss', - 'ESSD_L1', - 'ESSD_L2', - 'ESSD_L3', - 'SSD', - 'ESSD_L0', - ], - ], + 'schema' => ['title' => '节点个数，取值范围2-16', 'description' => '节点个数，取值范围2-16。使用NodeScaleMin、NodeScaleMax配置弹性区间时必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64', 'minimum' => '2', 'example' => '2'], ], [ 'name' => 'DBTimeZone', 'in' => 'query', - 'schema' => [ - 'title' => '数据库内核时区设置，应为IANA时区标识符。', - 'description' => '数据库内核时区设置，应为IANA时区标识符。', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['title' => '数据库内核时区设置，应为IANA时区标识符。', 'description' => '数据库内核时区设置，应为IANA时区标识符。', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai'], ], [ 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => 'enterprise', - ], + 'schema' => ['description' => '类型，取值说明：'."\n" + ."\n" + .'- enterprise 企业版', 'type' => 'string', 'required' => false, 'example' => 'enterprise', 'default' => 'enterprise'], ], [ 'name' => 'Tags', @@ -453,20 +764,8 @@ 'description' => '标签列表。', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '实例标签键。', - 'description' => '实例标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'user_123', - ], - 'Value' => [ - 'title' => '实例标签值。', - 'description' => '实例标签值。', - 'type' => 'string', - 'required' => false, - 'example' => '示例字符串', - ], + 'Key' => ['title' => '实例标签键。', 'description' => '实例标签键。', 'type' => 'string', 'required' => false, 'example' => 'user_123'], + 'Value' => ['title' => '实例标签值。', 'description' => '实例标签值。', 'type' => 'string', 'required' => false, 'example' => 'example string'], ], 'required' => false, ], @@ -480,39 +779,18 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '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-DE4DC9119F75', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'Data' => [ 'title' => '返回结果。', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'title' => '集群ID。', - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'OrderId' => [ - 'title' => '订单ID。', - 'description' => '订单ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21154955706****', - ], - 'ConnectionString' => [ - 'title' => '连接地址。', - 'description' => '连接地址。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', - ], + 'DBInstanceId' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'OrderId' => ['title' => '订单ID。', 'description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '21154955706****'], + 'ConnectionString' => ['title' => '连接地址。', 'description' => '连接地址。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com'], ], ], ], @@ -521,31 +799,35 @@ ], '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.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"OrderId\\": 0,\\n \\"ConnectionString\\": \\"cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com\\"\\n }\\n}","type":"json"}]', 'title' => '创建集群', - ], - 'DeleteDBInstance' => [ - 'summary' => '调用DeleteDBInstance接口释放云数据库ClickHouse企业版集群。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateEndpoint' => [ + 'summary' => '调用CreateEndpoint接口申请外网地址。', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -554,125 +836,119 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185379', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '185384', + 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], + ], + [ + 'name' => 'DBInstanceNetType', + 'in' => 'query', 'schema' => [ - 'description' => '目标集群ID。', + 'description' => '网络类型。', 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', + 'required' => false, + 'example' => 'Public', + 'enum' => ['Public'], ], ], + [ + 'name' => 'ConnectionPrefix', + 'in' => 'query', + 'schema' => ['description' => '目标连接地址的前缀。'."\n" + .'即ConnectionString参数的前缀部分。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com'], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => ['description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', - ], - 'Data' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\"\\n }\\n}","type":"json"}]', - 'title' => '释放集群', - ], - 'StartDBInstance' => [ - 'summary' => '调用StartDBInstance接口启动云数据库ClickHouse企业版集群。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', + 'title' => '申请外网地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateEndpoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'CreateLangfuseOrg' => [ + 'summary' => '创建Langfuse组织', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '189351', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '182031', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '地域id', 'description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse组织名称', 'type' => 'string', 'required' => true, 'example' => 'org_name'], + ], + [ + 'name' => 'OwnerEmail', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse组织Owner电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], ], ], 'responses' => [ @@ -682,91 +958,83 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'Data' => [ + 'title' => '返回结果。', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000837', - ], - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '企业版集群测试', - ], + 'OrganizationId' => ['title' => '集群ID。', 'description' => 'Langfuse组织ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw****'], + 'Name' => ['description' => 'Langfuse组织名称', 'type' => 'string', 'example' => 'org_name'], + 'CreatedAt' => ['description' => 'Langfuse组织创建时间', 'type' => 'string', 'example' => '2026-06-25T09:28:30.949Z'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000837,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', - 'title' => '启动集群', - ], - 'RestartDBInstance' => [ - 'summary' => '调用RestartDBInstance接口重启云数据库ClickHouse企业版集群。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'title' => '创建Langfuse组织', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw****\\",\\n \\"Name\\": \\"org_name\\",\\n \\"CreatedAt\\": \\"2026-06-25T09:28:30.949Z\\"\\n }\\n}","type":"json"}]', + ], + 'CreateLangfuseOrgMember' => [ + 'summary' => '将用户加入Langfuse组织', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '192305', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'OrganizationId', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => ['description' => '用户在组织中的角色', 'type' => 'string', 'required' => true, 'example' => 'VIEWER'], ], ], 'responses' => [ @@ -776,91 +1044,72 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], 'Data' => [ - 'description' => '返回结果。', + 'description' => '用户加入Langfuse组织信息', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001080', - ], - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '企业版集群测试', - ], + 'Role' => ['description' => '用户在组织中的角色', 'type' => 'string', 'example' => 'VIEWER'], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100001080,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', - 'title' => '重启集群', + 'title' => '将用户加入Langfuse组织', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"Role\\": \\"VIEWER\\",\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]', ], - 'StopDBInstance' => [ - 'summary' => '调用StopDBInstance接口暂停云数据库ClickHouse企业版集群。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateLangfuseProject' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '189348', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'OrganizationId', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse项目所在的组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse项目名称', 'type' => 'string', 'required' => true, 'example' => 'project_name'], ], ], 'responses' => [ @@ -870,58 +1119,41 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2C7393F1-5FD1-5CEE-A2EA-270A2CF99693'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000785', - ], - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '企业版集群测试', - ], + 'OrganizationId' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], + 'ProjectId' => ['description' => 'Langfuse项目ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], + 'Name' => ['description' => 'Langfuse项目名称', 'type' => 'string', 'example' => 'project_name'], + 'CreatedAt' => ['description' => 'Langfuse项目创建时间', 'type' => 'string', 'example' => '2026-06-24T10:14:33Z'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000785,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', - 'title' => '暂停集群', + 'title' => '创建Langfuse项目', + 'summary' => '创建Langfuse项目', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C7393F1-5FD1-5CEE-A2EA-270A2CF99693\\",\\n \\"Data\\": {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"ProjectId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Name\\": \\"project_name\\",\\n \\"CreatedAt\\": \\"2026-06-24T10:14:33Z\\"\\n }\\n}","type":"json"}]', ], - 'ModifyDBInstanceClass' => [ - 'summary' => '调用ModifyDBInstanceClass接口修改集群的弹性配置。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateLangfuseUser' => [ + 'summary' => '创建Langfuse用户', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -932,198 +1164,77 @@ 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '188578', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '182031', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '地域id', 'description' => '地域id', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '集群ID。', - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxxxx', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'ScaleMin', - 'in' => 'query', - 'schema' => [ - 'title' => '（参数废弃）serverless弹性伸缩最小值。', - 'description' => 'serverless弹性伸缩最小值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8', - ], - ], - [ - 'name' => 'ScaleMax', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'title' => '（参数废弃）serverless弹性伸缩最大值。', - 'description' => 'serverless弹性伸缩最大值。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], ], [ - 'name' => 'NodeScaleMax', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', - 'description' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '128', - 'minimum' => '4', - 'example' => '4', - ], + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => true, 'example' => 'john'], ], [ - 'name' => 'NodeScaleMin', - 'in' => 'query', - 'schema' => [ - 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', - 'description' => 'serverless节点弹性伸缩最小值。取值范围4-32', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '128', - 'minimum' => '4', - 'example' => '32', - ], - ], - [ - 'name' => 'NodeCount', - 'in' => 'query', - 'schema' => [ - 'title' => '节点个数，取值范围2-16', - 'description' => '节点个数，取值范围2-16', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '64', - 'minimum' => '1', - 'example' => '2', - ], - ], - [ - 'name' => 'StorageQuota', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'description' => '存储预购量（GB）', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '100', - ], + 'schema' => ['description' => '用户账号密码，设置规则如下。'."\n" + ."\n" + .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" + ."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + ."\n" + .'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => '2F9e9@******'], ], [ - 'name' => 'StorageType', + 'name' => 'OrganizationId', 'in' => 'query', - 'schema' => [ - 'title' => '存储类型。', - 'description' => '存储类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'OSS', - 'enum' => [ - 'oss', - 'ESSD_L1', - 'ESSD_L2', - 'ESSD_L3', - 'SSD', - 'ESSD_L0', - ], - ], + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => false, 'example' => 'cmrbhzx930005jw2q****'], ], [ - 'name' => 'ComputingGroupId', + 'name' => 'OrgRole', 'in' => 'query', - 'schema' => [ - 'title' => '计算组id', - 'description' => '计算组id', - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '用户在组织中的角色', 'type' => 'string', 'required' => false, 'example' => 'VIEWER'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'Data' => [ - 'title' => '返回数据。', - 'description' => '返回数据。', + 'title' => '返回结果。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID。', - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000****', - ], - 'ScaleMin' => [ - 'title' => 'serverless弹性伸缩最小值。', - 'description' => 'serverless弹性伸缩最小值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'ScaleMax' => [ - 'title' => 'serverless弹性伸缩最大值。', - 'description' => 'serverless弹性伸缩最大值。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'DBInstanceID' => [ - 'title' => '集群ID。', - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'cc-xxxxxxx'."\n", - ], - 'DBInstanceName' => [ - 'title' => '集群名称。', - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'cc-xxxxxxx'."\n", - ], - 'ComputingGroupId' => [ - 'type' => 'string', + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], + 'Name' => ['description' => '用户名称', 'type' => 'string', 'example' => 'john'], + 'CreatedAt' => ['description' => '用户创建时间', 'type' => 'string', 'example' => '2026-03-04T10:20:33Z'], + 'Membership' => [ + 'description' => '用户角色', + 'type' => 'object', + 'properties' => [ + 'OrganizationId' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], + 'Role' => ['description' => '用户在组织中的角色', 'type' => 'string', 'example' => 'VIEWER'], + ], ], ], ], @@ -1133,31 +1244,26 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidSpecification', - 'errorMessage' => 'Specification parameter is not valid.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"ScaleMin\\": 2,\\n \\"ScaleMax\\": 32,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"ComputingGroupId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => '修改集群弹性配置', - ], - 'ModifyDBInstanceAttribute' => [ - 'summary' => '调用ModifyDBInstanceAttribute接口修改集群的配置属性。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'title' => '创建Langfuse用户', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\",\\n \\"Name\\": \\"john\\",\\n \\"CreatedAt\\": \\"2026-03-04T10:20:33Z\\",\\n \\"Membership\\": {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Role\\": \\"VIEWER\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'CreateWhitelistTemplate' => [ + 'summary' => '新增白名单模板', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1166,482 +1272,365 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => ['title' => '白名单模板名称', 'description' => '白名单模板名称', 'type' => 'string', 'required' => true, 'example' => 'InvoiceTemplate'], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'formData', + 'schema' => ['title' => '白名单列表. 逗号分隔，数量不超过100个。', 'description' => '白名单列表。基于逗号分隔，数量不超过100个。', 'type' => 'string', 'required' => true, 'example' => '192.168.1.1,10.0.0.1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890'], + 'Data' => [ + 'title' => '', + 'description' => '返回数据', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem'], + 'TemplateName' => ['title' => '白名单模板名称', 'description' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'Specified IPList is not valid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplateName.Duplicated', 'errorMessage' => 'Whitelist template name duplicated.', 'description' => ''], + ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => ''], + ['errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplateName.CreateLimit', 'errorMessage' => 'Created Whitelist template name exceeded limit.', 'description' => ''], + ['errorCode' => 'InvalidIpWhitelistTemplateName.Malformed', 'errorMessage' => 'The templateName is not valid.', 'description' => ''], + ['errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', 'description' => ''], + ['errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '创建白名单模板', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DeleteAccount' => [ + 'summary' => '调用DeleteAccount接口删除账号。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '185273', + 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], + ], + 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxx', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ - 'name' => 'AttributeType', + 'name' => 'Account', 'in' => 'query', - 'schema' => [ - 'description' => '需要修改的类型。'."\n" - .'- MaintainTime：修改运维时间'."\n" - .'- DBInstanceDescription：修改实例名称', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'DBInstanceDescription', - 'enum' => [ - 'MaintainTime', - 'DBInstanceDescription', - ], - ], + 'schema' => ['description' => '目标数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], [ - 'name' => 'AttributeValue', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '需要修改的内容。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '产品code。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + 'schema' => ['description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '21D06907-CEA5-561D-B6B1-198BCCE99ED1'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Account' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'test1'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', - 'title' => '修改集群的配置属性', - ], - 'DescribeDBInstances' => [ - 'summary' => '调用DescribeDBInstances接口查询集群列表。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'title' => '删除账号', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21D06907-CEA5-561D-B6B1-198BCCE99ED1\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteBackupPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183135', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => ['FEATUREclickhouseN8BUWF'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx'], ], [ - 'name' => 'DBInstanceIds', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID列表，多个集群ID之间用英文半角逗号（,）分隔。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-xxxxx,cx-xxxx', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], - [ - 'name' => 'DBInstanceStatus', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群状态。', - 'type' => 'string', - 'required' => false, - 'example' => 'active', + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '60DDD29D-E5A8-563C-88FB-06D3A1F1C609'], + ], ], ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '集群描述。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除备份策略', + 'summary' => '删除ClickHouse企业版集群的备份策略。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60DDD29D-E5A8-563C-88FB-06D3A1F1C609\\"\\n}","type":"json"}]', + ], + 'DeleteDB' => [ + 'summary' => '调用DeleteDB接口删除数据库。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '30', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185312', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-4690g37929****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ - 'name' => 'Tags', + 'name' => 'DBName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '标签信息。', - 'description' => '标签信息。', - 'type' => 'array', - 'items' => [ - 'title' => '标签信息。', - 'description' => '标签信息。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键。', - 'description' => '标签键。', - 'type' => 'string', - 'required' => false, - 'example' => 'user_123', - ], - 'Value' => [ - 'title' => '标签值。', - 'description' => '标签值。', - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['description' => '目标数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb001'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '总记录数', - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageNumber' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DBInstances' => [ - 'description' => '实例详情列表。', - 'type' => 'array', - 'items' => [ - 'description' => '实例详情。', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-xxxxxxx', - ], - 'Description' => [ - 'description' => '参数描述。', - 'type' => 'string', - 'example' => 'test_desc', - ], - 'Engine' => [ - 'description' => '引擎类型。', - 'type' => 'string', - 'example' => 'clickhouse', - ], - 'EngineVersion' => [ - 'description' => '引擎版本。', - 'type' => 'string', - 'example' => '22.8', - ], - 'AliUid' => [ - 'description' => '用户ID。', - 'type' => 'string', - 'example' => '1294****', - ], - 'Bid' => [ - 'description' => '渠道ID。', - 'type' => 'string', - 'example' => '186681****', - ], - 'RegionId' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ZoneId' => [ - 'description' => '可用区ID', - 'type' => 'string', - 'example' => 'cn-hangzhou-i', - ], - 'ChargeType' => [ - 'description' => '付费方式。 取值：'."\n" - ."\n" - .'- PrePaid：包年包月。'."\n" - .'- PostPaid：按量付费。', - 'type' => 'string', - 'example' => 'PostPaid', - ], - 'Status' => [ - 'description' => '实例状态。', - 'type' => 'string', - 'example' => 'active', - ], - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-uf6kg****', - ], - 'VSwitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-8vb5mw****', - ], - 'ScaleMin' => [ - 'description' => 'serverless弹性伸缩最小值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ScaleMax' => [ - 'description' => 'serverless弹性伸缩最大值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'ExpireTime' => [ - 'description' => '到期时间。', - 'type' => 'string', - 'example' => '2024-02-16 11:51:06', - ], - 'LockMode' => [ - 'description' => '锁定模式。', - 'type' => 'string', - 'example' => '0', - ], - 'LockReason' => [ - 'description' => '锁定原因。', - 'type' => 'string', - 'example' => 'null', - ], - 'MaintainStartTime' => [ - 'description' => '可维护时间开始时间。', - 'type' => 'string', - 'example' => '00:00Z', - ], - 'MaintainEndTime' => [ - 'description' => '可维护时间结束时间。', - 'type' => 'string', - 'example' => '04:00:00Z', - ], - 'DeletionProtection' => [ - 'description' => '是否已开启释放保护功能。', - 'type' => 'string', - 'example' => 'False', - ], - 'ResourceGroupId' => [ - 'description' => '资源组ID。', - 'type' => 'string', - 'example' => 'rg-acfmzy****', - ], - 'CreateTime' => [ - 'description' => '创建时间。', - 'type' => 'string', - 'example' => '2022-12-04 21:16:15', - ], - 'Tags' => [ - 'description' => '标签组。', - 'type' => 'array', - 'items' => [ - 'description' => '标签。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => '标签键。', - 'type' => 'string', - 'example' => 'tag', - ], - 'Value' => [ - 'description' => '标签值。', - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - 'StorageType' => [ - 'title' => '实例存储类型', - 'description' => '实例存储类型', - 'type' => 'string', - 'example' => 'oss', - ], - ], - ], - ], + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb001'], ], ], - 'RequestId' => [ - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-xxxxxxx\\",\\n \\"Description\\": \\"test_desc\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"22.8\\",\\n \\"AliUid\\": \\"1294****\\",\\n \\"Bid\\": \\"186681****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"Status\\": \\"active\\",\\n \\"VpcId\\": \\"vpc-uf6kg****\\",\\n \\"VSwitchId\\": \\"vsw-8vb5mw****\\",\\n \\"ScaleMin\\": 1,\\n \\"ScaleMax\\": 13,\\n \\"ExpireTime\\": \\"2024-02-16 11:51:06\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"DeletionProtection\\": \\"False\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzy****\\",\\n \\"CreateTime\\": \\"2022-12-04 21:16:15\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StorageType\\": \\"oss\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', - 'title' => '查询集群列表', - ], - 'DescribeDBInstanceAttribute' => [ - 'summary' => '调用DescribeDBInstanceAttribute接口查询云数据库ClickHouse企业版集群的详细信息。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'title' => '删除数据库', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteDB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteDBInstance' => [ + 'summary' => '调用DeleteDBInstance接口释放云数据库ClickHouse企业版集群。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '183134', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '集群ID。', - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'cn-beijing' => 'cn-beijing', - ], - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '目标集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], ], 'responses' => [ @@ -1651,431 +1640,97 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], 'Data' => [ - 'title' => '返回结果。', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'title' => '集群ID。', - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'Description' => [ - 'title' => '集群描述。', - 'description' => '集群描述。', - 'type' => 'string', - 'example' => '集群测试', - ], - 'Engine' => [ - 'title' => '引擎类型。', - 'description' => '引擎类型。', - 'type' => 'string', - 'example' => 'clickhouse', - ], - 'EngineVersion' => [ - 'title' => '引擎版本。', - 'description' => '引擎版本。', - 'type' => 'string', - 'example' => '23.8', - ], - 'AliUid' => [ - 'title' => '阿里云账号ID。', - 'description' => '阿里云账号ID。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '140692647406****', - ], - 'Bid' => [ - 'title' => '渠道ID。', - 'description' => '渠道ID。', - 'type' => 'string', - 'example' => 'PD39050615820269****', - ], - 'RegionId' => [ - 'title' => '地域ID。', - 'description' => '地域ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'DeploySchema' => [ - 'title' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" - ."\n" - .'- single_az：server部署到主可用区ZoneId。'."\n" - .'- multi_az：server部署到多可用区MultiZones。'."\n" - ."\n" - .'keeper始终部署到多可用区MultiZones。', - 'description' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" - ."\n" - .'- single_az：server部署到主可用区ZoneId。'."\n" - .'- multi_az：server部署到多可用区MultiZones。'."\n" - ."\n" - .'keeper始终部署到多可用区MultiZones。', - 'type' => 'string', - 'example' => 'single_az', - ], - 'MultiZones' => [ - 'title' => '多可用信息。', - 'description' => '多可用信息。', - 'type' => 'array', - 'items' => [ - 'title' => '多可用信息。', - 'description' => '多可用信息。', - 'type' => 'object', - 'properties' => [ - 'VSwitchIds' => [ - 'title' => '交换机ID。', - 'description' => '交换机ID数组。', - 'type' => 'array', - 'items' => [ - 'title' => '交换机ID。', - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-bj9kpwhcb9iekphje1ljz', - ], - ], - 'ZoneId' => [ - 'title' => '可用区ID。', - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - ], - ], - ], - 'ChargeType' => [ - 'title' => '付费方式。 '."\n" - .'企业版集群的付费方式都是按量付费方式。', - 'description' => '付费方式。 '."\n" - .'企业版集群的付费方式都是按量付费方式。', - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'Status' => [ - 'title' => '实例状态。', - 'description' => '实例状态。', - 'type' => 'string', - 'example' => 'ACTIVATION', - ], - 'VpcId' => [ - 'title' => 'VPC ID。', - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-wz9duj8xd6r1gzhsg*****', - ], - 'VSwitchId' => [ - 'title' => '交换机ID。', - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-uf67ij56zm9x4uc6hmilg', - ], - 'ScaleMin' => [ - 'title' => 'serverless弹性伸缩最小值。', - 'description' => 'serverless弹性伸缩最小值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'ScaleMax' => [ - 'title' => 'serverless弹性伸缩最大值。', - 'description' => 'serverless弹性伸缩最大值。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '32', - ], - 'StorageSize' => [ - 'title' => '存储空间大小。单位：GB', - 'description' => '存储空间大小。单位：GB', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'StorageType' => [ - 'title' => '存储类型。', - 'description' => '存储类型。', - 'type' => 'string', - 'example' => '100', - ], - 'ObjectStoreSize' => [ - 'title' => '对象存储大小。', - 'description' => '对象存储大小。', - 'type' => 'string', - 'example' => '13', - ], - 'ExpireTime' => [ - 'title' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" - .'>按量付费集群无到期时间，返回值为空。', - 'description' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" - .'>按量付费集群无到期时间，返回值为空。', - 'type' => 'string', - 'example' => '2024-04-17T08:14:48Z', - ], - 'LockMode' => [ - 'title' => '集群的锁定模式。', - 'description' => '集群的锁定模式。', - 'type' => 'string', - 'example' => '0', - ], - 'LockReason' => [ - 'title' => '锁定原因。', - 'description' => '锁定原因。', - 'type' => 'string', - 'example' => 'nolock', - ], - 'MaintainStartTime' => [ - 'title' => '可维护时间开始时间。', - 'description' => '可维护时间开始时间。', - 'type' => 'string', - 'example' => '11:00Z', - ], - 'MaintainEndTime' => [ - 'title' => '可维护时间结束时间。', - 'description' => '可维护时间结束时间。', - 'type' => 'string', - 'example' => '12:00Z', - ], - 'DeletionProtection' => [ - 'title' => '是否已开启释放保护功能。', - 'description' => '是否已开启释放保护功能。', - 'type' => 'boolean', - 'example' => '0/1', - ], - 'ResourceGroupId' => [ - 'title' => '资源ID。', - 'description' => '资源ID。', - 'type' => 'string', - 'example' => 'rg-acfmzygvt54****', - ], - 'Tags' => [ - 'title' => '标签信息。', - 'description' => '标签信息。', - 'type' => 'array', - 'items' => [ - 'title' => '标签信息。', - 'description' => '标签信息。', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签的名称。', - 'description' => '标签的名称。', - 'type' => 'string', - 'example' => 'id', - ], - 'Value' => [ - 'title' => '标签的值。', - 'description' => '标签的值。', - 'type' => 'string', - 'example' => 'ck', - ], - ], - ], - ], - 'Nodes' => [ - 'title' => '节点信息。', - 'description' => '节点信息。', - 'type' => 'array', - 'items' => [ - 'title' => '节点信息。', - 'description' => '节点信息。', - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'title' => '可用区ID。', - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'NodeStatus' => [ - 'title' => '节点运行状态。', - 'description' => '节点运行状态。', - 'type' => 'string', - 'example' => 'active', - ], - ], - ], - ], - 'CreateTime' => [ - 'title' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', - 'description' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', - 'type' => 'string', - 'example' => '2023-09-14T08:14:48Z', - ], - 'EngineMinorVersion' => [ - 'title' => '集群引擎的小版本号。', - 'description' => '集群引擎的小版本号。', - 'type' => 'string', - 'example' => '23.8.1.41495_6', - ], - 'LatestEngineMinorVersion' => [ - 'title' => '最新内核小版本号。', - 'description' => '最新内核小版本号。', - 'type' => 'string', - 'example' => '23.8.1.41495_6', - ], - 'DisabledPorts' => [ - 'title' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', - 'description' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', - 'type' => 'string', - 'example' => '9001,8123', - ], - 'ZoneId' => [ - 'title' => '可用区ID。', - 'description' => '可用区ID。', - 'type' => 'string', - 'example' => 'cn-hangzhou-h', - ], - 'StorageQuota' => [ - 'title' => '存储预购量（GB）。', - 'description' => '存储预购量（GB）。', - 'type' => 'string', - 'example' => '100', - ], - 'NodeScaleMax' => [ - 'title' => 'Serverless节点弹性最大值。', - 'description' => 'Serverless节点弹性最大值。', - 'type' => 'string', - 'example' => '32', - ], - 'NodeScaleMin' => [ - 'title' => 'Serverless节点弹性最小值。', - 'description' => 'Serverless节点弹性最小值。', - 'type' => 'string', - 'example' => '4', - ], - 'NodeCount' => [ - 'title' => '节点数量。', - 'description' => '节点数量。', - 'type' => 'string', - 'example' => '2', - ], - 'Category' => [ - 'title' => '类型，取值说明：'."\n" - ."\n" - .'- enterprise 企业版', - 'description' => '类型，取值说明：'."\n" - ."\n" - .'- enterprise 企业版', - 'type' => 'string', - 'example' => 'enterprise', - ], - 'ClickObserveServiceStatus' => [ - 'title' => 'ClickObserve服务状态', - 'description' => 'ClickObserve服务状态', - 'type' => 'string', - 'example' => 'activation', - ], + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Description\\": \\"集群测试\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"23.8\\",\\n \\"AliUid\\": 0,\\n \\"Bid\\": \\"PD39050615820269****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeploySchema\\": \\"single_az\\",\\n \\"MultiZones\\": [\\n {\\n \\"VSwitchIds\\": [\\n \\"vsw-bj9kpwhcb9iekphje1ljz\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-wz9duj8xd6r1gzhsg*****\\",\\n \\"VSwitchId\\": \\"vsw-uf67ij56zm9x4uc6hmilg\\",\\n \\"ScaleMin\\": 8,\\n \\"ScaleMax\\": 32,\\n \\"StorageSize\\": 12,\\n \\"StorageType\\": \\"100\\",\\n \\"ObjectStoreSize\\": \\"13\\",\\n \\"ExpireTime\\": \\"2024-04-17T08:14:48Z\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"nolock\\",\\n \\"MaintainStartTime\\": \\"11:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmzygvt54****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"ck\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"NodeStatus\\": \\"active\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-14T08:14:48Z\\",\\n \\"EngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"LatestEngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"DisabledPorts\\": \\"9001,8123\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageQuota\\": \\"100\\",\\n \\"NodeScaleMax\\": \\"32\\",\\n \\"NodeScaleMin\\": \\"4\\",\\n \\"NodeCount\\": \\"2\\",\\n \\"Category\\": \\"enterprise\\",\\n \\"ClickObserveServiceStatus\\": \\"activation\\"\\n }\\n}","type":"json"}]', - 'title' => '查询集群的详细信息', - ], - 'UpgradeMinorVersion' => [ - 'summary' => '调用UpgradeMinorVersion接口升级指定云数据库ClickHouse企业版集群的内核小版本。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '释放集群', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteEndpoint' => [ + 'summary' => '调用DeleteEndpoint接口释放外网地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '196979', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseN0HBPQ', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185385', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1jyis8p15we****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'SwitchTimeMode', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '切换模式', - 'description' => '是否立即升级，取值说明：'."\n" - .'- **Immediate**：立即升级。'."\n" - .'- **MaintainTime**：在可运维时间段内升级。'."\n" - .'- **SpecifyTime**：指定时间升级。', - 'type' => 'string', - 'required' => false, - 'example' => 'Immediate', - 'default' => 'Immediate', - 'enum' => [ - 'Immediate', - 'MaintainTime', - 'SpecifyTime', - ], - ], + 'schema' => ['description' => '目标集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ - 'name' => 'SwitchTime', + 'name' => 'ConnectionString', 'in' => 'query', - 'schema' => [ - 'title' => '指定时间点切换时，指定切换时间点。', - 'description' => '指定的升级时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" - .'> 当SwitchTimeMode为SpecifyTime时，需要通过该参数指定升级时间。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-01-09T05:00:00Z', - ], + 'schema' => ['description' => '目标连接地址的前缀，即ConnectionString参数的前缀部分。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com'], ], [ - 'name' => 'TargetMinorVersion', + 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ - 'title' => '目标内核小版本，默认升级到最新。', - 'description' => '目标内核小版本。'."\n" - .'>默认不填写，直接升级到最新的内核小版本。', + 'description' => '网络类型，取值范围如下：'."\n" + ."\n" + .'- Vpc：Vpc 网络'."\n" + .'- Public：公网', 'type' => 'string', 'required' => false, - 'example' => '23.8.1.41495_6', + 'enumValueTitles' => ['Vpc' => 'Vpc', 'Public' => 'Public'], + 'example' => 'Public', ], ], [ - 'name' => 'RegionId', + 'name' => 'ComputingGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '计算组Id。', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze34****-clickhouse'], ], ], 'responses' => [ @@ -2085,46 +1740,41 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', - ], - 'Data' => [ - 'description' => '返回结果。', - 'type' => 'object', - 'properties' => [ - 'DBInstanceName' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'cc-uf6x229yeq166****', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"cc-uf6x229yeq166****\\"\\n }\\n}","type":"json"}]', - 'title' => '升级内核小版本', - ], - 'CreateAccount' => [ - 'summary' => '调用CreateAccount接口为云数据库ClickHouse企业版集群创建数据库账号。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + 'title' => '释放外网地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteEndpoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DeleteLangfuseInstance' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2133,188 +1783,108 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185272', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseL1079N', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], - ], - [ - 'name' => 'AccountType', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的类型，取值说明：'."\n" - .'- **NormalAccount**：普通账号。'."\n" - .'- **SuperAccount**：高权限账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'NormalAccount', - 'enum' => [ - 'SuperAccount', - 'NormalAccount', - ], - ], - ], - [ - 'name' => 'Account', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号，设置规则如下。'."\n" - .'- 名称唯一。'."\n" - .'- 由小写字母、数字或下划线组成。'."\n" - .'- 以小写字母开头，以小写字母或数字结尾。'."\n" - .'- 长度为2~64个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Password', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号密码，设置规则如下。'."\n" - ."\n" - .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" - ."\n" - .'- !@#$%^&*()_+-=为特殊字符。'."\n" - ."\n" - .'- 长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'example' => 'a1b2c3d4@', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], - [ - 'name' => 'DmlAuthSetting', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '授权信息。', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DmlAuthority' => [ - 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" - .'- **0**：允许进行读取、写入和更改设置的查询'."\n" - .'- **1**：仅允许进行读取数据的查询。'."\n" - .'- **2**：允许进行读取数据和更改设置的查询。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - 'enum' => [ - '0', - '1', - '2', - ], - ], - 'DdlAuthority' => [ - 'description' => '是否授予数据库账号DDL权限，取值如下：'."\n" - ."\n" - .'- **true**：允许DDL。'."\n" - .'- **false**：禁止DDL。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'AllowDictionaries' => [ - 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'array', - 'items' => [ - 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'dc1,dc2', - ], - 'required' => false, - ], - 'AllowDatabases' => [ - 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'array', - 'items' => [ - 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'db1,db2', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'example' => 'lfs-****'], ], - 'required' => false, ], ], - 'required' => false, ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '释放Langfuse实例', + 'summary' => '释放Langfuse实例', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"lfs-****\\"\\n }\\n}","type":"json"}]', + ], + 'DeleteLangfuseOrg' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Product', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '产品code。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'Description', + 'name' => 'OrganizationId', 'in' => 'query', - 'schema' => [ - 'description' => '备注说明。', - 'type' => 'string', - 'required' => false, - 'example' => '测试使用', - ], + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'Account' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'example' => 'test1', - ], + 'DBInstanceId' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'example' => 'lfs-****'], ], ], ], @@ -2322,52 +1892,25 @@ ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidAccountType.Malformed', - 'errorMessage' => 'The specified parameter "AccountType" is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountName.Malformed', - 'errorMessage' => 'The specified parameter "Account" is not valid.', - ], - [ - 'errorCode' => 'InvalidAccountPassword.Malformed', - 'errorMessage' => 'The specified parameter "Password" is not valid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'InvalidDBInstanceState.NotSupport', - 'errorMessage' => 'The specified instance state does\'t support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', - 'title' => '创建账号', + 'title' => '删除Langfuse组织', + 'summary' => '删除Langfuse组织', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"lfs-****\\"\\n }\\n}","type":"json"}]', ], - 'DeleteAccount' => [ - 'summary' => '调用DeleteAccount接口删除账号。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteLangfuseOrgMembership' => [ + 'summary' => '从Langfuse组织中移除用户', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2376,53 +1919,33 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '185273', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse2H8YOY', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Account', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'RegionId', + 'name' => 'OrganizationId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], ], [ - 'name' => 'Product', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => '产品code。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], ], ], 'responses' => [ @@ -2432,26 +1955,12 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '21D06907-CEA5-561D-B6B1-198BCCE99ED1', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'Account' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'example' => 'test1', - ], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], ], ], ], @@ -2459,38 +1968,24 @@ ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'InvalidDBInstanceState.NotSupport', - 'errorMessage' => 'The specified instance state does\'t support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21D06907-CEA5-561D-B6B1-198BCCE99ED1\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', - 'title' => '删除账号', + 'title' => '从Langfuse组织中移除用户', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]', ], - 'ResetAccountPassword' => [ - 'summary' => '调用ResetAccountPassword接口重置云数据库ClickHouse企业版集群的数据库账号密码。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteLangfuseProject' => [ + 'summary' => '删除Langfuse项目', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2502,66 +1997,93 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185276', - 'abilityTreeNodes' => [ - 'FEATUREclickhouse2H8YOY', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'RegionId', + 'name' => 'OrganizationId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], ], [ - 'name' => 'Account', + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'Langfuse项目ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '数据库账号名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '删除Langfuse项目', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', + ], + 'DeleteLangfuseUser' => [ + 'summary' => '删除Langfuse用户', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Password', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号的密码。'."\n" - ."\n" - .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" - .'- !@#$%^&*()_+-=为特殊字符。'."\n" - .'- 长度为8~32个字符。', - 'type' => 'string', - 'required' => true, - 'example' => '123456Aa', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Product', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '产品名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], ], ], 'responses' => [ @@ -2571,26 +2093,12 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '5A6A077A-577C-536E-AC13-8E715D7A34C8', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'Account' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'example' => 'test1', - ], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], ], ], ], @@ -2598,38 +2106,23 @@ ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'InvalidDBInstanceState.NotSupport', - 'errorMessage' => 'The specified instance state does\'t support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6A077A-577C-536E-AC13-8E715D7A34C8\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', - 'title' => '重置账号的密码', + 'title' => '删除Langfuse用户', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]', ], - 'ModifyAccountDescription' => [ - 'summary' => '调用ModifyAccountDescription接口修改账号的备注信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DeleteWhitelistTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2638,82 +2131,68 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185303', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域 ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1anv7jo84t****', - ], + 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Account', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '账号名称', - 'type' => 'string', - 'required' => true, - 'example' => 'testuser', - ], + 'schema' => ['title' => '白名单模板Id', 'description' => '白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca'], ], [ - 'name' => 'Description', + 'name' => 'TemplateName', 'in' => 'query', - 'schema' => [ - 'description' => '账号备注。', - 'type' => 'string', - 'required' => true, - 'example' => 'test', - ], + 'schema' => ['title' => '白名单模板Id', 'description' => '白名单模板ID。', 'type' => 'string', 'required' => false, 'example' => '98a6d3db05984dca'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7FFC9EBE-5023-5D5D-A5F0-1607E0F2****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '1234567890'], 'Data' => [ - 'description' => '返回数据。', + 'title' => '', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp1anv7jo84t****', - ], - 'Account' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'example' => 'testuser', + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '白名单模板列表。', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '模板详情。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID。', 'type' => 'string', 'example' => 'g-asdfwem'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'IP白名单列表。', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'description' => '关联的实例列表。', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'DbInstanceName' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'asdfwef'], + ], + ], + ], + ], + ], ], ], ], @@ -2722,173 +2201,113 @@ ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'InvalidDBInstanceState.NotSupport', - 'errorMessage' => 'The specified instance state does\'t support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FFC9EBE-5023-5D5D-A5F0-1607E0F2****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp1anv7jo84t****\\",\\n \\"Account\\": \\"testuser\\"\\n }\\n}","type":"json"}]', - 'title' => '修改账号备注', - ], - 'ModifyAccountAuthority' => [ - 'summary' => '调用ModifyAccountAuthority接口修改账号的授权信息。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '删除白名单模板', + 'summary' => '删除白名单模板。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DbInstanceName\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeAccountAuthority' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185304', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185309', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ 'name' => 'Account', 'in' => 'query', - 'schema' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'required' => true, - 'example' => 'test1', - ], - ], - [ - 'name' => 'DmlAuthSetting', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '授权信息。', - 'type' => 'object', - 'properties' => [ - 'DmlAuthority' => [ - 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" - ."\n" - .'- **0**：Read，Write，and Change settings queries are allowed.'."\n" - ."\n" - .'- **1**：Only Read data queries are allowed.'."\n" - ."\n" - .'- **2**：Read data and Change settings queries are allowed.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - 'enum' => [ - '0', - '1', - '2', - ], - ], - 'DdlAuthority' => [ - 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" - ."\n" - .'- **true**：允许DDL。'."\n" - .'- **false**：禁止DDL。', - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'AllowDictionaries' => [ - 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'array', - 'items' => [ - 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'db1,db2', - ], - 'required' => false, - ], - 'AllowDatabases' => [ - 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'array', - 'items' => [ - 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', - 'type' => 'string', - 'required' => false, - 'example' => 'db1,db2', - ], - 'required' => false, - ], - ], - 'required' => true, - ], + 'schema' => ['description' => '数据库账号的名称。', 'type' => 'string', 'required' => true, 'example' => 'test1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回结果详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC911****'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Account' => ['description' => '数据库账号的名称。', 'type' => 'string', 'example' => 'test1'], + 'DmlAuthority' => ['description' => '是否授予数据库账号DML权限。取值如下：'."\n" + ."\n" + .'- 0：Read，Write，and Change settings queries are allowed.'."\n" + .'- 1：Only Read data queries are allowed.'."\n" + ."\n" + .'- 2：Read data and Change settings queries are allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'DdlAuthority' => ['description' => '是否授予数据库账号DDL权限，取值说明：'."\n" + ."\n" + .'- **true**：允许DDL。'."\n" + .'- **false**：禁止DDL。'."\n", 'type' => 'boolean', 'example' => 'true'], + 'AllowDatabases' => [ + 'description' => '已授权的数据库列表。', + 'type' => 'array', + 'items' => ['description' => '已授权的数据库列表。', 'type' => 'string', 'example' => 'db1'], + ], + 'AllowDictionaries' => [ + 'description' => '已授权的字典列表。', + 'type' => 'array', + 'items' => ['description' => '已授权的字典列表。', 'type' => 'string', 'example' => 'dt1'], ], - 'Account' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'example' => 'test1', + 'TotalDatabases' => [ + 'description' => '所有数据库列表。', + 'type' => 'array', + 'items' => ['description' => '所有数据库列表。', 'type' => 'string', 'example' => 'db1,db2'], + ], + 'TotalDictionaries' => [ + 'description' => '数据库。', + 'type' => 'array', + 'items' => ['description' => 'db.dict形式，代表某数据库的某字典', 'type' => 'string', 'example' => 'test1.range_key_dict'], ], ], ], @@ -2897,38 +2316,38 @@ ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'InvalidDBInstanceState.NotSupport', - 'errorMessage' => 'The specified instance state does\'t support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ['errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', 'description' => '指定的账号名称不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', - 'title' => '修改账号的授权信息', + 'title' => '查看账号权限', + 'summary' => '调用DescribeAccountAuthority接口查看账号权限。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC911****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\",\\n \\"DmlAuthority\\": 0,\\n \\"DdlAuthority\\": true,\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"test1.range_key_dict\\"\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeAccounts' => [ 'summary' => '调用DescribeAccounts接口查询指定云数据库ClickHouse集群的数据库账号列表。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -2941,65 +2360,37 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185288', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + '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', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'string', 'required' => false, 'example' => '30'], ], [ 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '产品code。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + 'schema' => ['description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], ], ], 'responses' => [ @@ -3009,72 +2400,37 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数，取值说明：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageNumber' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数，取值说明：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'Accounts' => [ 'description' => '账号列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Account' => [ - 'description' => '数据库账号。', - 'type' => 'string', - 'example' => 'test', - ], - 'Description' => [ - 'description' => '备注信息。', - 'type' => 'string', - 'example' => '测试使用', - ], - 'AccountType' => [ - 'description' => '数据库账号的类型，取值说明：'."\n" - .'- **1**：普通账号。'."\n" - .'- **6**：高权限账号。', - 'type' => 'string', - 'example' => '1', - ], - 'Status' => [ - 'description' => '账号状态。取值说明：'."\n" - ."\n" - .'- **0**：创建中。'."\n" - ."\n" - .'- **1**：使用中。'."\n" - ."\n" - .'- **3**：删除中。', - 'type' => 'string', - 'example' => '1', - ], + 'Account' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'test'], + 'Description' => ['description' => '备注信息。', 'type' => 'string', 'example' => 'For testing'], + 'AccountType' => ['description' => '数据库账号的类型，取值说明：'."\n" + .'- **1**：普通账号。'."\n" + .'- **6**：高权限账号。', 'type' => 'string', 'example' => '1'], + 'Status' => ['description' => '账号状态。取值说明：'."\n" + ."\n" + .'- **0**：创建中。'."\n" + ."\n" + .'- **1**：使用中。'."\n" + ."\n" + .'- **3**：删除中。', 'type' => 'string', 'example' => '1'], ], + 'description' => '', ], ], ], @@ -3085,77 +2441,264 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', - ], + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Accounts\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"AccountType\\": \\"1\\",\\n \\"Status\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Accounts\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"Description\\": \\"For testing\\",\\n \\"AccountType\\": \\"1\\",\\n \\"Status\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询账号列表', - ], - 'DescribeAccountAuthority' => [ - 'summary' => '调用DescribeAccountAuthority接口查看账号权限。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccounts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeBackupPolicy' => [ + 'summary' => '查看ClickHouse企业版集群的备份策略', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185309', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'], ], 'parameters' => [ [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], + ], + [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => ['description' => '备份周期。'."\n" + .'取值如下：'."\n" + ."\n" + .'- **Monday**：周一。'."\n" + .'- **Tuesday**：周二。'."\n" + .'- **Wednesday**：周三。'."\n" + .'- **Thursday**：周四。'."\n" + .'- **Friday**：周五。'."\n" + .'- **Saturday**：周六。'."\n" + .'- **Sunday**：周日。', 'type' => 'string', 'example' => 'Monday'], + 'Switch' => ['description' => '是否开启备份。'."\n" + .'取值如下：'."\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' => '备份保留天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], + 'BackupSize' => ['description' => '备份文件大小。'."\n" + .'单位：MB。', 'type' => 'string', 'example' => '123124'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查看备份策略', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","type":"json"}]', + ], + 'DescribeBackups' => [ + 'summary' => '查询ClickHouse企业版集群的备份集。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'], + ], + 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1v9kq45u0o80cvh'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => ['description' => '备份记录ID。', 'type' => 'string', 'required' => false, 'example' => '117403****'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => '备份开始时间，UTC时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-21T16:00Z'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => '备份结束时间，UTC时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-25T16:00Z'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '备份总个数。', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', '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' => [ + 'description' => '备份集列表。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp179i5956tih2m93'], + 'BackupStatus' => ['description' => '备份集状态。', 'type' => 'string', 'example' => 'Success'], + 'BackupType' => ['description' => '备份类型。'."\n" + .'取值如下：'."\n" + ."\n" + .'- **FullBackup**：全量备份。'."\n" + .'- **IncrementalBackup**：增量备份。', 'type' => 'string', 'example' => 'IncrementalBackup'], + 'BackupStartTime' => ['description' => '备份开始时间。', 'type' => 'string', 'example' => '2021-11-22T18:28:22Z'], + 'BackupSize' => ['description' => '备份文件大小，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '131072'], + 'BackupEndTime' => ['description' => '本次备份结束时间，UTC时间。', 'type' => 'string', 'example' => '2021-11-22T18:28:41Z'], + 'BackupSetInfo' => ['description' => '备份集信息。', 'type' => 'string', 'example' => '{"shard_count": 4}'], + 'BackupId' => ['description' => '备份记录ID。', 'type' => 'string', 'example' => '117403****'], + 'BackupMethod' => ['description' => '备份方法。', 'type' => 'string', 'example' => 'Physical'], + 'ExpireDate' => ['description' => '备份集过期时间。', 'type' => 'string', 'example' => '2022-07-22T18:28:41Z'], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查看备份集', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-bp179i5956tih2m93\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DescribeDBInstanceAttribute' => [ + 'summary' => '调用DescribeDBInstanceAttribute接口查询云数据库ClickHouse企业版集群的详细信息。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Account', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183134', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], + ], + [ + 'name' => 'RegionId', 'in' => 'query', 'schema' => [ - 'description' => '数据库账号的名称。', + 'title' => '地域ID。', + 'description' => '地域ID。', 'type' => 'string', - 'required' => true, - 'example' => 'test1', + 'required' => false, + 'enumValueTitles' => ['cn-beijing' => 'cn-beijing'], + 'example' => 'cn-hangzhou', ], ], ], @@ -3163,182 +2706,177 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC911****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], 'Data' => [ + 'title' => '返回结果。', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'Account' => [ - 'description' => '数据库账号的名称。', - 'type' => 'string', - 'example' => 'test1', - ], - 'DmlAuthority' => [ - 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" - ."\n" - .'- 0：Read，Write，and Change settings queries are allowed.'."\n" - .'- 1：Only Read data queries are allowed.'."\n" - ."\n" - .'- 2：Read data and Change settings queries are allowed.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'DdlAuthority' => [ - 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" - ."\n" - .'- **true**：允许DDL。'."\n" - .'- **false**：禁止DDL。'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AllowDatabases' => [ - 'description' => '已授权的数据库列表。', + 'DBInstanceId' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Description' => ['title' => '集群描述。', 'description' => '集群描述。', 'type' => 'string', 'example' => 'cluster test'], + 'Engine' => ['title' => '引擎类型。', 'description' => '引擎类型。', 'type' => 'string', 'example' => 'clickhouse'], + 'EngineVersion' => ['title' => '引擎版本。', 'description' => '引擎版本。', 'type' => 'string', 'example' => '23.8'], + 'AliUid' => ['title' => '阿里云账号ID。', 'description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '140692647406****'], + 'Bid' => ['title' => '渠道ID。', 'description' => '渠道ID。', 'type' => 'string', 'example' => 'PD39050615820269****'], + 'RegionId' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'DeploySchema' => ['title' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" + ."\n" + .'- single_az：server部署到主可用区ZoneId。'."\n" + .'- multi_az：server部署到多可用区MultiZones。'."\n" + ."\n" + .'keeper始终部署到多可用区MultiZones。', 'description' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" + ."\n" + .'- single_az：server部署到主可用区ZoneId。'."\n" + .'- multi_az：server部署到多可用区MultiZones。'."\n" + ."\n" + .'keeper始终部署到多可用区MultiZones。', 'type' => 'string', 'example' => 'single_az'], + 'MultiZones' => [ + 'title' => '多可用信息。', + 'description' => '多可用信息。', 'type' => 'array', 'items' => [ - 'description' => '已授权的数据库列表。', - 'type' => 'string', - 'example' => 'db1', + 'title' => '多可用信息。', + 'description' => '多可用信息。', + 'type' => 'object', + 'properties' => [ + 'VSwitchIds' => [ + 'title' => '交换机ID。', + 'description' => '交换机ID数组。', + 'type' => 'array', + 'items' => ['title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bj9kpwhcb9iekphje1ljz'], + ], + 'ZoneId' => ['title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + ], ], ], - 'AllowDictionaries' => [ - 'description' => '已授权的字典列表。', + 'ChargeType' => ['title' => '付费方式。 '."\n" + .'企业版集群的付费方式都是按量付费方式。', 'description' => '付费方式。 '."\n" + .'企业版集群的付费方式都是按量付费方式。', 'type' => 'string', 'example' => 'POSTPAY'], + 'Status' => ['title' => '实例状态。', 'description' => '实例状态。', 'type' => 'string', 'example' => 'ACTIVATION'], + 'VpcId' => ['title' => 'VPC ID。', 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-wz9duj8xd6r1gzhsg*****'], + 'VSwitchId' => ['title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-uf67ij56zm9x4uc6hmilg'], + 'ScaleMin' => ['title' => 'serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], + 'ScaleMax' => ['title' => 'serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '32'], + 'StorageSize' => ['title' => '存储空间大小。单位：GB', 'description' => '存储空间大小。单位：GB', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'StorageType' => ['title' => '存储类型。', 'description' => '存储类型。', 'type' => 'string', 'example' => '100'], + 'ObjectStoreSize' => ['title' => '对象存储大小。', 'description' => '对象存储大小。', 'type' => 'string', 'example' => '13'], + 'ExpireTime' => ['title' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>按量付费集群无到期时间，返回值为空。', 'description' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>按量付费集群无到期时间，返回值为空。', 'type' => 'string', 'example' => '2024-04-17T08:14:48Z'], + 'LockMode' => ['title' => '集群的锁定模式。', 'description' => '集群的锁定模式。', 'type' => 'string', 'example' => '0'], + 'LockReason' => ['title' => '锁定原因。', 'description' => '锁定原因。', 'type' => 'string', 'example' => 'nolock'], + 'MaintainStartTime' => ['title' => '可维护时间开始时间。', 'description' => '可维护时间开始时间。', 'type' => 'string', 'example' => '11:00Z'], + 'MaintainEndTime' => ['title' => '可维护时间结束时间。', 'description' => '可维护时间结束时间。', 'type' => 'string', 'example' => '12:00Z'], + 'DeletionProtection' => ['title' => '是否已开启释放保护功能。', 'description' => '是否已开启释放保护功能。', 'type' => 'boolean', 'example' => '0/1'], + 'ResourceGroupId' => ['title' => '资源ID。', 'description' => '资源ID。', 'type' => 'string', 'example' => 'rg-acfmzygvt54****'], + 'Tags' => [ + 'title' => '标签信息。', + 'description' => '标签信息。', 'type' => 'array', 'items' => [ - 'description' => '已授权的字典列表。', - 'type' => 'string', - 'example' => 'dt1', + 'title' => '标签信息。', + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签的名称。', 'description' => '标签的名称。', 'type' => 'string', 'example' => 'id'], + 'Value' => ['title' => '标签的值。', 'description' => '标签的值。', 'type' => 'string', 'example' => 'ck'], + ], ], ], - 'TotalDatabases' => [ - 'description' => '所有数据库列表。', + 'Nodes' => [ + 'title' => '节点信息。', + 'description' => '节点信息。', 'type' => 'array', 'items' => [ - 'description' => '所有数据库列表。', - 'type' => 'string', - 'example' => 'db1,db2', + 'title' => '节点信息。', + 'description' => '节点信息。', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'NodeStatus' => ['title' => '节点运行状态。', 'description' => '节点运行状态。', 'type' => 'string', 'example' => 'active'], + ], ], ], - 'TotalDictionaries' => [ - 'description' => '数据库。', + 'CreateTime' => ['title' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', 'description' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2023-09-14T08:14:48Z'], + 'EngineMinorVersion' => ['title' => '集群引擎的小版本号。', 'description' => '集群引擎的小版本号。', 'type' => 'string', 'example' => '23.8.1.41495_6'], + 'LatestEngineMinorVersion' => ['title' => '最新内核小版本号。', 'description' => '最新内核小版本号。', 'type' => 'string', 'example' => '23.8.1.41495_6'], + 'DisabledPorts' => ['title' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', 'description' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', 'type' => 'string', 'example' => '9001,8123'], + 'ZoneId' => ['title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h'], + 'StorageQuota' => ['title' => '存储预购量（GB）。', 'description' => '存储预购量（GB）。', 'type' => 'string', 'example' => '100'], + 'NodeScaleMax' => ['title' => 'Serverless节点弹性最大值。', 'description' => 'Serverless节点弹性最大值。', 'type' => 'string', 'example' => '32'], + 'NodeScaleMin' => ['title' => 'Serverless节点弹性最小值。', 'description' => 'Serverless节点弹性最小值。', 'type' => 'string', 'example' => '4'], + 'NodeCount' => ['title' => '节点数量。', 'description' => '节点数量。', 'type' => 'string', 'example' => '2'], + 'Category' => ['title' => '类型，取值说明：'."\n" + ."\n" + .'- enterprise 企业版', 'description' => '类型，取值说明：'."\n" + ."\n" + .'- enterprise 企业版', 'type' => 'string', 'example' => 'enterprise'], + 'ClickObserveServiceStatus' => ['title' => 'ClickObserve服务状态', 'description' => 'ClickObserve服务状态', 'type' => 'string', 'example' => 'activation'], + 'LangfuseInstanceIds' => [ + 'title' => 'Langfuse实例Id列表', + 'description' => 'Langfuse实例Id列表', 'type' => 'array', - 'items' => [ - 'description' => 'db.dict形式，代表某数据库的某字典', - 'type' => 'string', - 'example' => 'test1.range_key_dict', - ], + 'items' => ['title' => 'Langfuse实例Id', 'description' => 'Langfuse实例Id', 'type' => 'string', 'example' => 'lfs-2ze172q******'], ], + 'WebUISnatStatus' => ['type' => 'string', 'example' => 'active'], ], ], ], ], ], ], - 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - [ - 'errorCode' => 'InvalidAccountName.NotFound', - 'errorMessage' => 'Specified account name does not exist.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC911****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\",\\n \\"DmlAuthority\\": 0,\\n \\"DdlAuthority\\": true,\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"test1.range_key_dict\\"\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查看账号权限', - ], - 'CreateDB' => [ - 'summary' => '调用CreateDB接口创建数据库。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '查询集群的详细信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Description\\": \\"cluster test\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"23.8\\",\\n \\"AliUid\\": 0,\\n \\"Bid\\": \\"PD39050615820269****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeploySchema\\": \\"single_az\\",\\n \\"MultiZones\\": [\\n {\\n \\"VSwitchIds\\": [\\n \\"vsw-bj9kpwhcb9iekphje1ljz\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-wz9duj8xd6r1gzhsg*****\\",\\n \\"VSwitchId\\": \\"vsw-uf67ij56zm9x4uc6hmilg\\",\\n \\"ScaleMin\\": 8,\\n \\"ScaleMax\\": 32,\\n \\"StorageSize\\": 12,\\n \\"StorageType\\": \\"100\\",\\n \\"ObjectStoreSize\\": \\"13\\",\\n \\"ExpireTime\\": \\"2024-04-17T08:14:48Z\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"nolock\\",\\n \\"MaintainStartTime\\": \\"11:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmzygvt54****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"ck\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"NodeStatus\\": \\"active\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-14T08:14:48Z\\",\\n \\"EngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"LatestEngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"DisabledPorts\\": \\"9001,8123\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageQuota\\": \\"100\\",\\n \\"NodeScaleMax\\": \\"32\\",\\n \\"NodeScaleMin\\": \\"4\\",\\n \\"NodeCount\\": \\"2\\",\\n \\"Category\\": \\"enterprise\\",\\n \\"ClickObserveServiceStatus\\": \\"activation\\",\\n \\"LangfuseInstanceIds\\": [\\n \\"lfs-2ze172q******\\"\\n ],\\n \\"WebUISnatStatus\\": \\"active\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceConfig' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185311', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '204414', + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], - ], - [ - 'name' => 'DBName', - 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。命名规则如下：'."\n" - .'- 由小写字母、数字、下划线（_）、中划线（-）组成。'."\n" - .'- 以小写字母开头，且以小写字母或数字结尾。'."\n" - .'- 长度最多为64个字符。'."\n" - ."\n" - .'><notice>下划线（_）会被看作两个字符。></notice>', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb001', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-wz9go4x*****'], ], [ - 'name' => 'Comment', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '备注信息。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], ], 'responses' => [ @@ -3348,25 +2886,29 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n"], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'testdb001', + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Params' => [ + 'description' => '用户参数。', + 'type' => 'array', + 'items' => [ + 'description' => '用户参数。', + 'type' => 'object', + 'properties' => [ + 'IsDynamic' => ['description' => '是否动态生效（不需要重启）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'IsUserModifiable' => ['description' => '用户是否可修改。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DefaultValue' => ['description' => '参数默认值。', 'type' => 'string', 'example' => '1'], + 'Name' => ['description' => '参数名。', 'type' => 'string', 'example' => 'max_concurrent_queries'], + 'Optional' => ['description' => '参数取值范围。', 'type' => 'string', 'example' => '[0-100]'], + 'Comment' => ['description' => '参数备注信息。', 'type' => 'string', 'example' => 'Maximum number of concurrently executed queries. Zero means unlimited.'], + 'ParamRelyRule' => ['description' => '参数依赖。', 'type' => 'string', 'example' => '0'], + 'Value' => ['description' => '参数值。', 'type' => 'string', 'example' => '100'], + ], + ], ], ], ], @@ -3374,85 +2916,76 @@ ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'InvalidDBInstanceState.NotSupport', - 'errorMessage' => 'The specified instance state does\'t support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', - 'title' => '创建数据库', - ], - 'DeleteDB' => [ - 'summary' => '调用DeleteDB接口删除数据库。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '查询实例参数配置', + 'summary' => '查询实例参数配置', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Params\\": [\\n {\\n \\"IsDynamic\\": 1,\\n \\"IsUserModifiable\\": 1,\\n \\"DefaultValue\\": \\"1\\",\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"Optional\\": \\"[0-100]\\",\\n \\"Comment\\": \\"Maximum number of concurrently executed queries. Zero means unlimited.\\",\\n \\"ParamRelyRule\\": \\"0\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceConfigChangeLog' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '185312', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '206401', + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-uf6lkzf*****'], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss 。', 'type' => 'string', 'required' => true, 'example' => '2025-01-01 10:00:00'], ], [ - 'name' => 'DBName', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '目标数据库名称。', - 'type' => 'string', - 'required' => true, - 'example' => 'testdb001', - ], + 'schema' => ['description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss 。', 'type' => 'string', 'required' => true, 'example' => '2025-01-01 10:00:00'."\n"], + ], + [ + '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'], ], ], 'responses' => [ @@ -3462,25 +2995,34 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '780DE414-*********-88BE-A2E21B862B57'], 'Data' => [ - 'description' => '返回结果。', + 'description' => '查询结果集。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'testdb001', + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'ParamChangeLogs' => [ + 'description' => '参数变更记录。', + 'type' => 'array', + 'items' => [ + 'description' => '参数变更记录。', + 'type' => 'object', + 'properties' => [ + 'ID' => ['description' => '操作ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Name' => ['description' => '参数名称。', 'type' => 'string', 'example' => 'max_concurrent_queries'], + 'OldValue' => ['description' => ' '."\n" + .'旧参数值。', 'type' => 'string', 'example' => '50'], + 'NewValue' => ['description' => ' '."\n" + .'新参数值。', 'type' => 'string', 'example' => '100'], + 'Applied' => ['description' => '配置是否生效：'."\n" + ."\n" + .'- true：生效'."\n" + ."\n" + .'- false：不生效', 'type' => 'boolean'], + 'GmtCreated' => ['description' => '变更创建时间。', 'type' => 'string', 'example' => '2025-06-25 13:46:06'], + 'GmtModified' => ['description' => '变更修改时间。', 'type' => 'string', 'example' => '2025-06-25 13:46:06'."\n"], + ], + ], ], ], ], @@ -3488,38 +3030,33 @@ ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'InvalidDBInstanceState.NotSupport', - 'errorMessage' => 'The specified instance state does\'t support this operation.', - ], - ], - [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', - 'title' => '删除数据库', + 'title' => '查询实例参数变更记录', + 'summary' => '查询实例参数配置记录', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceConfigChangeLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"780DE414-*********-88BE-A2E21B862B57\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"ParamChangeLogs\\": [\\n {\\n \\"ID\\": 1,\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"OldValue\\": \\"50\\",\\n \\"NewValue\\": \\"100\\",\\n \\"Applied\\": true,\\n \\"GmtCreated\\": \\"2025-06-25 13:46:06\\",\\n \\"GmtModified\\": \\"2025-06-25 13:46:06\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeDBInstanceDataSources' => [ 'summary' => '调用DescribeDBInstanceDataSources接口查询DB或者Table的数据结构。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3532,50 +3069,28 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185313', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ 'name' => 'DBName', 'in' => 'query', - 'schema' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'dbtest', - ], + 'schema' => ['description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'dbtest'], ], [ 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => '表名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'tableTest', - ], + 'schema' => ['description' => '表名称。', 'type' => 'string', 'required' => false, 'example' => 'tableTest'], ], ], 'responses' => [ @@ -3585,34 +3100,17 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F543E6CC-6868-523D-8D28-0E92CF977ED2', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F543E6CC-6868-523D-8D28-0E92CF977ED2'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'Schemas' => [ - 'description' => '账号。', - 'type' => 'string', - 'example' => 'default', - ], + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Schemas' => ['description' => '账号。', 'type' => 'string', 'example' => 'default'], 'Tables' => [ 'description' => '表列表。', 'type' => 'array', - 'items' => [ - 'description' => '表列表。', - 'type' => 'string', - 'example' => 'table_test', - ], + 'items' => ['description' => '表列表。', 'type' => 'string', 'example' => 'table_test'], ], 'Columns' => [ 'description' => '列类型。', @@ -3621,39 +3119,15 @@ 'description' => '列类型。', 'type' => 'object', 'properties' => [ - 'DBName' => [ - 'description' => '数据库名称。', - 'type' => 'string', - 'example' => 'dbtest', - ], - 'Type' => [ - 'description' => '存储数据类型。', - 'type' => 'string', - 'example' => 'UInt64', - ], - 'TableName' => [ - 'description' => '表名。', - 'type' => 'string', - 'example' => 'tableTest', - ], - 'ColumnName' => [ - 'description' => '列名。', - 'type' => 'string', - 'example' => 'c31', - ], - 'PrimaryKey' => [ - 'description' => '列是否为主键，取值说明：'."\n" - ."\n" - .'- **true**：主键。'."\n" - .'- **false**：非主键。', - 'type' => 'string', - 'example' => 'false', - ], - 'Comment' => [ - 'description' => '数据库账号的描述。', - 'type' => 'string', - 'example' => '测试', - ], + 'DBName' => ['description' => '数据库名称。', 'type' => 'string', 'example' => 'dbtest'], + 'Type' => ['description' => '存储数据类型。', 'type' => 'string', 'example' => 'UInt64'], + 'TableName' => ['description' => '表名。', 'type' => 'string', 'example' => 'tableTest'], + 'ColumnName' => ['description' => '列名。', 'type' => 'string', 'example' => 'c31'], + 'PrimaryKey' => ['description' => '列是否为主键，取值说明：'."\n" + ."\n" + .'- **true**：主键。'."\n" + .'- **false**：非主键。', 'type' => 'string', 'example' => 'false'], + 'Comment' => ['description' => '数据库账号的描述。', 'type' => 'string', 'example' => 'Test'], ], ], ], @@ -3665,97 +3139,111 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound ', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBInstanceId.NotFound ', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F543E6CC-6868-523D-8D28-0E92CF977ED2\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Schemas\\": \\"default\\",\\n \\"Tables\\": [\\n \\"table_test\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"DBName\\": \\"dbtest\\",\\n \\"Type\\": \\"UInt64\\",\\n \\"TableName\\": \\"tableTest\\",\\n \\"ColumnName\\": \\"c31\\",\\n \\"PrimaryKey\\": \\"false\\",\\n \\"Comment\\": \\"测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F543E6CC-6868-523D-8D28-0E92CF977ED2\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Schemas\\": \\"default\\",\\n \\"Tables\\": [\\n \\"table_test\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"DBName\\": \\"dbtest\\",\\n \\"Type\\": \\"UInt64\\",\\n \\"TableName\\": \\"tableTest\\",\\n \\"ColumnName\\": \\"c31\\",\\n \\"PrimaryKey\\": \\"false\\",\\n \\"Comment\\": \\"Test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询DB或者Table的数据结构', - ], - 'CreateEndpoint' => [ - 'summary' => '调用CreateEndpoint接口申请外网地址。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeDBInstances' => [ + 'summary' => '调用DescribeDBInstances接口查询集群列表。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185384', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseZHDS8I', - ], + 'abilityTreeCode' => '183135', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'DBInstanceIds', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '集群ID列表，多个集群ID之间用英文半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'cc-xxxxx,cx-xxxx'], ], [ - 'name' => 'DBInstanceNetType', + 'name' => 'VpcIds', 'in' => 'query', - 'schema' => [ - 'description' => '网络类型。', - 'type' => 'string', - 'required' => false, - 'example' => 'Public', - 'enum' => [ - 'Public', - ], - ], + 'schema' => ['title' => 'Vpc Id列表', 'description' => 'Vpc Id列表', 'type' => 'string', 'required' => false, 'example' => 'vpc-2ze4ee9z******,vpc-2ze4ee9z5l******'], ], [ - 'name' => 'ConnectionPrefix', + 'name' => 'DBInstanceStatus', 'in' => 'query', - 'schema' => [ - 'description' => '目标连接地址的前缀。'."\n" - .'即ConnectionString参数的前缀部分。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', - ], + 'schema' => ['description' => '集群状态。', 'type' => 'string', 'required' => false, 'example' => 'active'], ], [ - 'name' => 'ComputingGroupId', + 'name' => 'Description', 'in' => 'query', + 'schema' => ['description' => '集群描述。', 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'title' => '标签信息。', + 'description' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'title' => '标签信息。', + 'description' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'user_123'], + 'Value' => ['title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'example value'], + ], + 'required' => false, + ], 'required' => false, + 'example' => 'DescribeDBInstances', + 'maxItems' => 20, ], ], ], @@ -3763,100 +3251,246 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => '总记录数', 'type' => 'string', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'DBInstances' => [ + 'description' => '实例详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-xxxxxxx'], + 'Description' => ['description' => '参数描述。', 'type' => 'string', 'example' => 'test_desc'], + 'Engine' => ['description' => '引擎类型。', 'type' => 'string', 'example' => 'clickhouse'], + 'EngineVersion' => ['description' => '引擎版本。', 'type' => 'string', 'example' => '22.8'], + 'AliUid' => ['description' => '用户ID。', 'type' => 'string', 'example' => '1294****'], + 'Bid' => ['description' => '渠道ID。', 'type' => 'string', 'example' => '186681****'], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou'], + 'ZoneId' => ['description' => '可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou-i'], + 'ChargeType' => ['description' => '付费方式。 取值：'."\n" + ."\n" + .'- PrePaid：包年包月。'."\n" + .'- PostPaid：按量付费。', 'type' => 'string', 'example' => 'PostPaid'], + 'Status' => ['description' => '实例状态。', 'type' => 'string', 'example' => 'active'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-uf6kg****'], + 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-8vb5mw****'], + 'ScaleMin' => ['description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ScaleMax' => ['description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '13'], + 'ExpireTime' => ['description' => '到期时间。', 'type' => 'string', 'example' => '2024-02-16 11:51:06'], + 'LockMode' => ['description' => '锁定模式。', 'type' => 'string', 'example' => '0'], + 'LockReason' => ['description' => '锁定原因。', 'type' => 'string', 'example' => 'null'], + 'MaintainStartTime' => ['description' => '可维护时间开始时间。', 'type' => 'string', 'example' => '00:00Z'], + 'MaintainEndTime' => ['description' => '可维护时间结束时间。', 'type' => 'string', 'example' => '04:00:00Z'], + 'DeletionProtection' => ['description' => '是否已开启释放保护功能。', 'type' => 'string', 'example' => 'False'], + 'ResourceGroupId' => ['description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfmzy****'], + 'CreateTime' => ['description' => '创建时间。', 'type' => 'string', 'example' => '2022-12-04 21:16:15'], + 'Tags' => [ + 'description' => '标签组。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => '标签键。', 'type' => 'string', 'example' => 'tag'], + 'Value' => ['description' => '标签值。', 'type' => 'string', 'example' => 'test'], + ], + ], + ], + 'StorageType' => ['title' => '实例存储类型', 'description' => '实例存储类型', 'type' => 'string', 'example' => 'oss'], + ], + ], + ], + ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', - 'title' => '申请外网地址', - ], - 'DeleteEndpoint' => [ - 'summary' => '调用DeleteEndpoint接口释放外网地址。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-xxxxxxx\\",\\n \\"Description\\": \\"test_desc\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"22.8\\",\\n \\"AliUid\\": \\"1294****\\",\\n \\"Bid\\": \\"186681****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"Status\\": \\"active\\",\\n \\"VpcId\\": \\"vpc-uf6kg****\\",\\n \\"VSwitchId\\": \\"vsw-8vb5mw****\\",\\n \\"ScaleMin\\": 1,\\n \\"ScaleMax\\": 13,\\n \\"ExpireTime\\": \\"2024-02-16 11:51:06\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"DeletionProtection\\": \\"False\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzy****\\",\\n \\"CreateTime\\": \\"2022-12-04 21:16:15\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StorageType\\": \\"oss\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', + 'title' => '查询集群列表', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeEndpoints' => [ + 'summary' => '调用DescribeEndpoints接口查询集群的访问地址。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185385', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185373', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '目标集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx'], ], [ - 'name' => 'ConnectionString', + 'name' => 'ComputingGroupId', 'in' => 'query', + 'schema' => ['title' => '计算组ID。', 'description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-*****-clickhouse'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '目标连接地址的前缀，即ConnectionString参数的前缀部分。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'InstanceNetworkType' => ['description' => '实例的网络类型，取值：'."\n" + .'* **VPC**：专有网络。'."\n" + .'* **PUBLIC**：公网网络。', 'type' => 'string', 'example' => 'VPC'], + 'Endpoints' => [ + 'description' => 'Endpoint详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Endpoint详细信息。', + 'type' => 'object', + 'properties' => [ + 'NetType' => ['description' => '连接地址的网络类型，取值：'."\n" + .'- VPC：专有网络。'."\n" + .'- PUBLIC：公网网络。', 'type' => 'string', 'example' => 'VPC'], + 'Status' => ['description' => '状态。', 'type' => 'string', 'example' => 'active'], + 'ConnectionString' => ['description' => '实例连接地址', 'type' => 'string', 'example' => 'cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-uf61z****'], + 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-0xi8829****'], + 'VpcInstanceId' => ['description' => 'VPC实例ID。', 'type' => 'string', 'example' => 'vpc-uf61z****'], + 'Ports' => [ + 'description' => '端口详细信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '端口详细信息。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => ['description' => '协议类型。取值范围：'."\n" + ."\n" + .'- HttpPort：HTTP端口号。'."\n" + .'- HttpsPort：HTTPS端口号。'."\n" + .'- TcpPort：TCP端口号。', 'type' => 'string', 'example' => 'HttpPort'], + 'Port' => ['description' => '访问端口。取值范围：'."\n" + ."\n" + .'- HttpPort：8123'."\n" + .'- HttpsPort：8443'."\n" + .'- TcpPort：9000', 'type' => 'integer', 'format' => 'int32', 'example' => '8123'], + ], + ], + ], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '172.30.XX.XX'], + 'ComputingGroupId' => ['title' => '计算组id', 'description' => '计算组id', 'type' => 'string', 'example' => 'cc-ad321**-clickhouse'], + 'EndpointName' => ['title' => '连接串名称', 'description' => '连接串名称', 'type' => 'string', 'example' => 'cc-*****-clickhouse'], + ], + ], + ], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"Status\\": \\"active\\",\\n \\"ConnectionString\\": \\"cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"VpcInstanceId\\": \\"vpc-uf61z****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"HttpPort\\",\\n \\"Port\\": 8123\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.XX.XX\\",\\n \\"ComputingGroupId\\": \\"cc-ad321**-clickhouse\\",\\n \\"EndpointName\\": \\"cc-*****-clickhouse\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询集群访问地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeEndpoints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'DescribeLangfuseEndpoints' => [ + 'summary' => '查询Langfuse实例访问地址', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBInstanceNetType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185373', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ComputingGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], ], 'responses' => [ @@ -3866,11 +3500,48 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], + 'Data' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'InstanceNetworkType' => ['description' => '实例的网络类型，取值：'."\n" + .'* **VPC**：专有网络。', 'type' => 'string', 'example' => 'VPC'], + 'Endpoints' => [ + 'description' => '端点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '端点列表。', + 'type' => 'object', + 'properties' => [ + 'NetType' => ['description' => '连接地址的网络类型，取值：'."\n" + .'- VPC：专有网络。'."\n" + .'- PUBLIC：公网网络。', 'type' => 'string', 'example' => 'VPC'], + 'ConnectionString' => ['description' => '实例连接地址', 'type' => 'string', 'example' => 'lfs-2zeejcvmzn1******.com'], + 'VpcId' => ['description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-uf61z****'], + 'VSwitchId' => ['description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-0xi8829****'], + 'Ports' => [ + 'description' => '端口详细信息。', + 'type' => 'array', + 'items' => [ + 'description' => '端口详细信息。', + 'type' => 'object', + 'properties' => [ + 'Protocol' => ['description' => '协议类型。取值范围：'."\n" + ."\n" + .'- http：HTTP端口号。', 'type' => 'string', 'example' => 'http'], + 'Port' => ['description' => '访问端口。取值范围：'."\n" + ."\n" + .'- http：3000', 'type' => 'integer', 'format' => 'int32', 'example' => '3000'], + ], + ], + ], + 'IPAddress' => ['description' => 'IP地址。', 'type' => 'string', 'example' => '172.30.****.****'], + 'EndpointName' => ['title' => '连接串名称', 'description' => '连接串名称', 'type' => 'string', 'example' => 'lfs-2zeejcvmzn1******'], + ], + ], + ], + ], ], ], ], @@ -3878,184 +3549,204 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', - ], + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', - 'title' => '释放外网地址', + 'title' => '查询Langfuse实例访问地址', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"ConnectionString\\": \\"lfs-2zeejcvmzn1******.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"http\\",\\n \\"Port\\": 3000\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.****.****\\",\\n \\"EndpointName\\": \\"lfs-2zeejcvmzn1******\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ModifyDBInstanceConnectionString' => [ - 'summary' => '调用ModifyDBInstanceConnectionString接口修改集群的连接地址。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'DescribeLangfuseOrgMemberships' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'high', + 'operationType' => 'list', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186649', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxx', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'ConnectionString', + 'name' => 'OrganizationId', 'in' => 'query', - 'schema' => [ - 'description' => '连接地址。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', - ], + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], ], [ - 'name' => 'ConnectionStringPrefix', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '连接数据库的地址前辍。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-****-clickhouse', - ], + 'schema' => ['description' => '分页参数：当前页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ - 'name' => 'DisablePorts', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '- 禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。'."\n" - .'- 仅内核版本大于等于24.10.1.11098_1的集群支持此参数。'."\n" - .'><notice>集群创建时其版本低于24.10.1.11098_1，后期升级到24.10.1.11098_1版本及以上的版本，不支持此参数。</notice>', - 'type' => 'string', - 'required' => false, - 'example' => '9001,8123', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0'], + 'Data' => [ + 'description' => '返回的结果。', + 'type' => 'object', + 'properties' => [ + 'Memberships' => [ + 'description' => '组织内用户角色列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], + 'Name' => ['description' => '用户名称', 'type' => 'string', 'example' => 'john'], + 'Role' => ['description' => '用户角色', 'type' => 'string', 'example' => 'VIEWER'], + 'CreatedAt' => ['description' => '用户创建时间', 'type' => 'string', 'example' => '2026-06-24T10:14:33Z'], + ], + 'description' => '', + ], + ], + 'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询Langfuse组织成员信息', + 'summary' => '查询Langfuse组织成员信息', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\",\\n \\"Data\\": {\\n \\"Memberships\\": [\\n {\\n \\"Email\\": \\"john@company.com\\",\\n \\"Name\\": \\"john\\",\\n \\"Role\\": \\"VIEWER\\",\\n \\"CreatedAt\\": \\"2026-06-24T10:14:33Z\\"\\n }\\n ],\\n \\"TotalCount\\": 3,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20\\n }\\n}","type":"json"}]', + ], + 'DescribeLangfuseOrgs' => [ + 'summary' => '查询Langfuse实例组织列表', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBInstanceNetType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183135', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'Public', - ], - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ComputingGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], 'Data' => [ - 'description' => '返回数据。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'cc-xxxxx', - ], - 'ConnectionString' => [ - 'description' => '连接地址。', - 'type' => 'string', - 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'cc-xxxxx', - ], - 'DisabledPorts' => [ - 'description' => '已经禁用的数据库端口。', - 'type' => 'string', - 'example' => '9001,8123', + 'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '17'], + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'PageNumber' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Organizations' => [ + 'description' => 'Langfuse组织信息', + 'type' => 'array', + 'items' => [ + 'description' => 'Langfuse 组织信息', + 'type' => 'object', + 'properties' => [ + 'OrganizationId' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], + 'Name' => ['description' => 'Langfuse组织名称', 'type' => 'string', 'example' => 'org_name'], + 'CreatedAt' => ['description' => 'Langfuse组织创建时间', 'type' => 'string', 'example' => '2026-06-11T10:27:23Z'], + 'UpdatedAt' => ['description' => 'Langfuse 组织更新时间', 'type' => 'string', 'example' => '2026-06-09T10:27:55'], + ], + ], ], ], ], + 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"ConnectionString\\": \\"cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"cc-xxxxx\\",\\n \\"DisabledPorts\\": \\"9001,8123\\"\\n }\\n}","type":"json"}]', - 'title' => '修改连接地址', + 'title' => '查询Langfuse实例组织列表', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": 17,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"Organizations\\": [\\n {\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Name\\": \\"org_name\\",\\n \\"CreatedAt\\": \\"2026-06-11T10:27:23Z\\",\\n \\"UpdatedAt\\": \\"2026-06-09T10:27:55\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', ], - 'ModifySecurityIPList' => [ - 'summary' => '调用ModifySecurityIPList接口变更集群白名单设置。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeLangfuseProjectMemberships' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4064,129 +3755,73 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxx', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'GroupName', + 'name' => 'OrganizationId', 'in' => 'query', - 'schema' => [ - 'description' => '操作的分组名称。', - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], ], [ - 'name' => 'SecurityIPList', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '白名单IP地址。', - 'type' => 'string', - 'required' => false, - 'example' => '192.168.0.0/24,172.16.0.0/24', - ], + 'schema' => ['description' => 'Langfuse项目ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], ], [ - 'name' => 'ModifyMode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '修改模式。'."\n" - .'- 0：覆盖修改'."\n" - .'- 1：增加'."\n" - .'- 2：删除'."\n" - ."\n" - .'> 建议固定指定0进行覆盖修改', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页参数：当前页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A82758F8-E793-5610-BE11-0E46664305C2'], 'Data' => [ - 'description' => '返回数据。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'GroupName' => [ - 'description' => '分组名称。', - 'type' => 'string', - 'example' => 'test', - ], - 'SecurityIPType' => [ - 'description' => 'IP地址类型。', - 'type' => 'string', - 'example' => 'ipv4', - ], - 'GroupTag' => [ - 'description' => '分组标签。', - 'type' => 'string', - 'example' => 'test', - ], - 'TaskId' => [ - 'description' => '任务ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SecurityIPList' => [ - 'description' => '白名单分组下的IP列表。', - 'type' => 'string', - 'example' => '192.168.0.0/24,172.16.0.0/24', - ], - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'cc-xxxx', - ], - 'WhitelistNetType' => [ - 'description' => '白名单的网络类型。', - 'type' => 'string', - 'example' => 'mix', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'cc-xxxx', + 'PageSize' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'PageNumber' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'Memberships' => [ + 'description' => 'Langfuse项目的用户角色列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '用户名称', 'type' => 'string', 'example' => 'john'], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], + 'ProjectRole' => ['description' => '用户在Langfuse项目中的角色', 'type' => 'string', 'example' => 'VIEWER'], + 'OrgRole' => ['description' => '用户在Langfuse组织中的角色', 'type' => 'string', 'example' => 'ADMIN'], + ], + 'description' => '', + ], ], ], ], @@ -4196,64 +3831,136 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', - ], + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"TaskId\\": 1,\\n \\"SecurityIPList\\": \\"192.168.0.0/24,172.16.0.0/24\\",\\n \\"DBInstanceID\\": 0,\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"cc-xxxx\\"\\n }\\n}","type":"json"}]', - 'title' => '变更白名单', + 'title' => '查询Langfuse项目用户角色', + 'summary' => '查询Langfuse项目用户角色', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A82758F8-E793-5610-BE11-0E46664305C2\\",\\n \\"Data\\": {\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 4,\\n \\"Memberships\\": [\\n {\\n \\"Name\\": \\"john\\",\\n \\"Email\\": \\"john@company.com\\",\\n \\"ProjectRole\\": \\"VIEWER\\",\\n \\"OrgRole\\": \\"ADMIN\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeSecurityIPList' => [ - 'summary' => '调用DescribeSecurityIPList接口查询白名单。', - 'methods' => [ - 'post', - 'get', + 'DescribeLangfuseProjects' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'OrganizationId', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Projects' => [ + 'description' => 'Langfuse项目列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Langfuse 项目列表', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'Langfuse项目ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], + 'Name' => ['description' => 'Langfuse项目名称', 'type' => 'string', 'example' => 'project_name'], + 'OrganizationId' => ['description' => 'Langfuse项目所在的组织ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], + 'UpdatedAt' => ['description' => 'Langfuse 项目更新时间', 'type' => 'string', 'example' => '2026-06-09T10:27:35'], + 'CreatedAt' => ['description' => 'Langfuse项目创建时间', 'type' => 'string', 'example' => '2026-05-27T08:23:45Z'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], + 'title' => '查询Langfuse项目列表', + 'summary' => '查询Langfuse项目列表', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 1,\\n \\"Projects\\": [\\n {\\n \\"ProjectId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"Name\\": \\"project_name\\",\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"UpdatedAt\\": \\"2026-06-09T10:27:35\\",\\n \\"CreatedAt\\": \\"2026-05-27T08:23:45Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeLangfuseSecurityIPList' => [ + 'summary' => '查询Langfuse白名单列表', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', 'abilityTreeCode' => '185650', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], ], 'responses' => [ @@ -4263,27 +3970,13 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '集群测试', - ], + 'DBInstanceID' => ['description' => '实例ID', 'type' => 'integer', 'format' => 'int32', 'example' => 'lfs-****'], + 'DBInstanceName' => ['description' => '实例名称', 'type' => 'string', 'example' => 'lfs-****'], 'GroupItems' => [ 'description' => '白名单分组列表。', 'type' => 'array', @@ -4291,31 +3984,11 @@ 'description' => '白名单分组列表。', 'type' => 'object', 'properties' => [ - 'GroupName' => [ - 'description' => '白名单分组名称。', - 'type' => 'string', - 'example' => 'default', - ], - 'SecurityIPType' => [ - 'description' => 'IP地址的类型。', - 'type' => 'string', - 'example' => 'ipv4', - ], - 'GroupTag' => [ - 'description' => '分组标签。', - 'type' => 'string', - 'example' => 'test', - ], - 'SecurityIPList' => [ - 'description' => '白名单分组下的IP列表。', - 'type' => 'string', - 'example' => '127.0.XX.XX', - ], - 'WhitelistNetType' => [ - 'description' => '白名单的网络类型。', - 'type' => 'string', - 'example' => 'mix', - ], + 'GroupName' => ['description' => '白名单分组名称。', 'type' => 'string', 'example' => 'default'], + 'SecurityIPType' => ['description' => 'IP地址类型。取值固定为IPv4，暂不支持IPv6。', 'type' => 'string', 'example' => 'ipv4'], + 'GroupTag' => ['description' => '分组标签', 'type' => 'string', 'example' => 'test'], + 'SecurityIPList' => ['description' => '白名单分组下的IP列表。', 'type' => 'string', 'example' => '127.0.XX.XX'], + 'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'], ], ], ], @@ -4325,25 +3998,19 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询白名单', + 'title' => '查询Langfuse白名单列表', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"lfs-****\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DescribeEndpoints' => [ - 'summary' => '调用DescribeEndpoints接口查询集群的访问地址。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'DescribeLangfuseUser' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4352,156 +4019,69 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185373', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxx', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'ComputingGroupId', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'title' => '计算组ID。', - 'description' => '计算组ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cc-*****-clickhouse', - ], + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'InstanceNetworkType' => [ - 'description' => '实例的网络类型，取值：'."\n" - .'* **VPC**：专有网络。'."\n" - .'* **PUBLIC**：公网网络。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'Endpoints' => [ - 'description' => 'Endpoint详细信息列表。', + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], + 'Name' => ['description' => '用户名称', 'type' => 'string', 'example' => 'john'], + 'CreatedAt' => ['description' => '用户创建时间', 'type' => 'string', 'example' => '2026-06-01T10:03:05Z'], + 'UpdatedAt' => ['description' => '用户更新时间', 'type' => 'string', 'example' => '2026-06-01T10:03:05Z'], + 'Memberships' => [ + 'description' => '该用户的所有角色信息', 'type' => 'array', 'items' => [ - 'description' => 'Endpoint详细信息。', + 'description' => '该用户的角色信息', 'type' => 'object', 'properties' => [ - 'NetType' => [ - 'description' => '连接地址的网络类型，取值：'."\n" - .'- VPC：专有网络。'."\n" - .'- PUBLIC：公网网络。', - 'type' => 'string', - 'example' => 'VPC', - ], - 'Status' => [ - 'description' => '状态。', - 'type' => 'string', - 'example' => 'active', - ], - 'ConnectionString' => [ - 'description' => '实例连接地址', - 'type' => 'string', - 'example' => 'cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com', - ], - 'VpcId' => [ - 'description' => 'VPC ID。', - 'type' => 'string', - 'example' => 'vpc-uf61z****', - ], - 'VSwitchId' => [ - 'description' => '交换机ID。', - 'type' => 'string', - 'example' => 'vsw-0xi8829****', - ], - 'VpcInstanceId' => [ - 'description' => 'VPC实例ID。', - 'type' => 'string', - 'example' => 'vpc-uf61z****', - ], - 'Ports' => [ - 'description' => '端口详细信息列表。', + 'OrgRole' => ['description' => '在组织内的角色', 'type' => 'string', 'example' => 'ADMIN'], + 'OrganizationId' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], + 'OrganizationName' => ['description' => 'Langfuse组织名称', 'type' => 'string', 'example' => 'org_name'], + 'Projects' => [ + 'description' => 'Langfuse组织列表', 'type' => 'array', 'items' => [ - 'description' => '端口详细信息。', + 'description' => 'Langfuse组织列表', 'type' => 'object', 'properties' => [ - 'Protocol' => [ - 'description' => '协议类型。取值范围：'."\n" - ."\n" - .'- HttpPort：HTTP端口号。'."\n" - .'- HttpsPort：HTTPS端口号。'."\n" - .'- TcpPort：TCP端口号。', - 'type' => 'string', - 'example' => 'HttpPort', - ], - 'Port' => [ - 'description' => '访问端口。取值范围：'."\n" - ."\n" - .'- HttpPort：8123'."\n" - .'- HttpsPort：8443'."\n" - .'- TcpPort：9000', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8123', - ], + 'ProjectRole' => ['description' => '在项目内的角色', 'type' => 'string', 'example' => 'VIEWER'], + 'ProjectName' => ['description' => 'Langfuse项目名称', 'type' => 'string', 'example' => 'project_name'], + 'ProjectId' => ['description' => 'Langfuse项目ID', 'type' => 'string', 'example' => 'cmrbhzx930005jw2q****'], ], ], ], - 'IPAddress' => [ - 'description' => 'IP地址。', - 'type' => 'string', - 'example' => '172.30.XX.XX', - ], - 'ComputingGroupId' => [ - 'title' => '计算组id', - 'description' => '计算组id', - 'type' => 'string', - 'example' => 'cc-ad321**-clickhouse', - ], - 'EndpointName' => [ - 'title' => '连接串名称', - 'description' => '连接串名称', - 'type' => 'string', - 'example' => 'cc-*****-clickhouse', - ], ], ], ], @@ -4513,31 +4093,124 @@ ], 'errorCodes' => [ 404 => [ - [ - 'errorCode' => 'InvalidDBInstanceId.NotFound', - 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询Langfuse用户详情', + 'summary' => '查询Langfuse用户详情', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\",\\n \\"Name\\": \\"john\\",\\n \\"CreatedAt\\": \\"2026-06-01T10:03:05Z\\",\\n \\"UpdatedAt\\": \\"2026-06-01T10:03:05Z\\",\\n \\"Memberships\\": [\\n {\\n \\"OrgRole\\": \\"ADMIN\\",\\n \\"OrganizationId\\": \\"cmrbhzx930005jw2q****\\",\\n \\"OrganizationName\\": \\"org_name\\",\\n \\"Projects\\": [\\n {\\n \\"ProjectRole\\": \\"VIEWER\\",\\n \\"ProjectName\\": \\"project_name\\",\\n \\"ProjectId\\": \\"cmrbhzx930005jw2q****\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeLangfuseUsers' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => false, 'example' => 'john@company.com'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => '用户名称', 'type' => 'string', 'required' => false, 'example' => 'john'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '分页参数：当前页码。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => '分页参数：每页显示条数。', 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + 'PageNumber' => ['description' => '分页参数：当前页码。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Users' => [ + 'description' => '用户列表', + 'type' => 'array', + 'items' => [ + 'description' => '用户列表', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '用户名称', 'type' => 'string', 'example' => 'john'], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], + 'CreatedAt' => ['description' => '用户创建时间', 'type' => 'string', 'example' => '2026-06-01T10:03:05Z'], + ], + ], + ], + ], + ], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"Status\\": \\"active\\",\\n \\"ConnectionString\\": \\"cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"VpcInstanceId\\": \\"vpc-uf61z****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"HttpPort\\",\\n \\"Port\\": 8123\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.XX.XX\\",\\n \\"ComputingGroupId\\": \\"cc-ad321**-clickhouse\\",\\n \\"EndpointName\\": \\"cc-*****-clickhouse\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询集群访问地址', + 'title' => '查询Langfuse用户列表', + 'summary' => '查询Langfuse用户列表', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2\\",\\n \\"Data\\": {\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 10,\\n \\"Users\\": [\\n {\\n \\"Name\\": \\"john\\",\\n \\"Email\\": \\"john@company.com\\",\\n \\"CreatedAt\\": \\"2026-06-01T10:03:05Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeProcessList' => [ 'summary' => '调用DescribeProcessList接口查看正在运行中的查询。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4550,117 +4223,64 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '186631', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxx', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx'], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL的执行耗时，单位ms，最小1000 ms。', - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => '慢SQL的执行耗时，单位ms，最小1000 ms。', 'type' => 'string', 'required' => false, 'example' => '1000'], ], [ 'name' => 'InitialUser', 'in' => 'query', - 'schema' => [ - 'description' => '查询用户。', - 'type' => 'string', - 'required' => false, - 'example' => 'testuser', - ], + 'schema' => ['description' => '查询用户。', 'type' => 'string', 'required' => false, 'example' => 'testuser'], ], [ 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => '查询语句的关键字。', - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT', - ], + 'schema' => ['description' => '查询语句的关键字。', 'type' => 'string', 'required' => false, 'example' => 'SELECT'], ], [ 'name' => 'InitialQueryId', 'in' => 'query', - 'schema' => [ - 'description' => '查询ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '查询ID。', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'QueryOrder', 'in' => 'query', - 'schema' => [ - 'description' => '按指定列倒序排序。'."\n" - ."\n" - .'- 0表示仅用query_duration_ms排序'."\n" - ."\n" - .'- 1表示用query_duration_ms、query_start_time排序'."\n" - ."\n" - .'- 2表示用query_duration_ms、query_start_time、user排序', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => '按指定列倒序排序。'."\n" + ."\n" + .'- 0表示仅用query_duration_ms排序'."\n" + ."\n" + .'- 1表示用query_duration_ms、query_start_time排序'."\n" + ."\n" + .'- 2表示用query_duration_ms、query_start_time、user排序', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-gs5j3sua77******-clickhouse'], ], ], 'responses' => [ @@ -4670,70 +4290,27 @@ 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], 'Data' => [ 'description' => '返回的结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'cc-xxxx', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '测试使用', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxx'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'For testing'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ResultSet' => [ 'description' => '结果集。', 'type' => 'array', 'items' => [ + 'description' => '结果集。', 'type' => 'object', 'properties' => [ - 'InitialQueryId' => [ - 'description' => '查询ID。', - 'type' => 'string', - 'example' => '\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'', - ], - 'QueryStartTime' => [ - 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', - 'type' => 'string', - 'example' => '2023-07-23T10:13:23Z', - ], - 'InitialAddress' => [ - 'description' => '查询地址。', - 'type' => 'string', - 'example' => '0:0:0:0:0:ffff:1edd65ea', - ], - 'Query' => [ - 'description' => '正在查询的语句。', - 'type' => 'string', - 'example' => 'select * from test', - ], - 'InitialUser' => [ - 'description' => '查询用户。', - 'type' => 'string', - 'example' => 'bany', - ], - 'QueryDurationMs' => [ - 'description' => '最短的查询耗时。最小值为**1000**。单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], + 'InitialQueryId' => ['description' => '查询ID。', 'type' => 'string', 'example' => '\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\''], + 'QueryStartTime' => ['description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2023-07-23T10:13:23Z'], + 'InitialAddress' => ['description' => '查询地址。', 'type' => 'string', 'example' => '0:0:0:0:0:ffff:1edd65ea'], + 'Query' => ['description' => '正在查询的语句。', 'type' => 'string', 'example' => 'select * from test'], + 'InitialUser' => ['description' => '查询用户。', 'type' => 'string', 'example' => 'bany'], + 'QueryDurationMs' => ['description' => '最短的查询耗时。最小值为**1000**。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], ], ], ], @@ -4743,115 +4320,159 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"测试使用\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"InitialQueryId\\": \\"\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'\\",\\n \\"QueryStartTime\\": \\"2023-07-23T10:13:23Z\\",\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"For testing\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"InitialQueryId\\": \\"\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'\\",\\n \\"QueryStartTime\\": \\"2023-07-23T10:13:23Z\\",\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查看正在运行中的查询', - ], - 'KillProcess' => [ - 'summary' => '调用KillProcess接口终止正在进行的任务。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeProcessList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeRegions' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186648', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '19455', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '请求id', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], + 'Regions' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Region' => [ + 'description' => '地域ID。', + '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-beijing-k'], + 'VpcEnabled' => ['description' => '是否支持VPC，取值说明：'."\n" + ."\n" + .'- **true**：支持VPC。'."\n" + .'- **false**：不支持VPC。', 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'description' => '', + ], + 'RegionId' => ['description' => '地域ID。', 'type' => 'string', 'example' => 'cn-beijing'], + ], + ], + ], + ], + 'description' => '', + ], + ], + 'description' => '', ], ], + ], + 'title' => '获取ClickHouse企业版可用地域', + 'summary' => '查询云数据库ClickHouse企业版所有地域和可用区的信息', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Regions\\": {\\n \\"Region\\": [\\n {\\n \\"Zones\\": {\\n \\"Zone\\": [\\n {\\n \\"ZoneId\\": \\"cn-beijing-k\\",\\n \\"VpcEnabled\\": true\\n }\\n ]\\n },\\n \\"RegionId\\": \\"cn-beijing\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeSecurityIPList' => [ + 'summary' => '调用DescribeSecurityIPList接口查询白名单。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxxxx', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '185650', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ [ - 'name' => 'InitialQueryId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '查询ID。', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ComputingGroupId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回参数详情。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'xxx-xxx-xxx', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], 'Data' => [ - 'description' => '返回数据', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'cc-xxxxxxx', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => 'cc-xxxxxxx'."\n", - ], - 'Count' => [ - 'description' => '结束任务数量。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z3****'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'Cluster test'], + 'GroupItems' => [ + 'description' => '白名单分组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '白名单分组列表。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['description' => '白名单分组名称。', 'type' => 'string', 'example' => 'default'], + 'SecurityIPType' => ['description' => 'IP地址的类型。', 'type' => 'string', 'example' => 'ipv4'], + 'GroupTag' => ['description' => '分组标签。', 'type' => 'string', 'example' => 'test'], + 'SecurityIPList' => ['description' => '白名单分组下的IP列表。', 'type' => 'string', 'example' => '127.0.XX.XX'], + 'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'], + ], + ], ], ], ], @@ -4859,25 +4480,32 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"Count\\": 1\\n }\\n}","type":"json"}]', - 'title' => '终止正在进行的任务', - ], - 'DescribeSlowLogTrend' => [ - 'summary' => '调用DescribeSlowLogTrend接口查询慢日志趋势。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Cluster test\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询白名单', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSecurityIPList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeSlowLogRecords' => [ + 'summary' => '调用DescribeSlowLogRecords接口查询慢日志明细。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4886,113 +4514,72 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186604', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '186629', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-13 17:48:00', - ], + 'schema' => ['description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-09-11 16:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-06-07 10:03:00', - ], + 'schema' => ['description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-09-15 16:00:00'], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', - 'type' => 'string', - 'required' => false, - 'example' => '3000', - ], + 'schema' => ['description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', 'type' => 'string', 'required' => false, 'example' => '3000'], ], [ - 'name' => 'Product', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '产品code。', - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - 'default' => 'clickhouse', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- 30（默认值）'."\n" + .'- 50'."\n" + .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-wz9v6y29y3******-clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '集群测试', - ], + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z32****'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'Cluster test'], + 'TotalCount' => ['description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ResultSet' => [ 'description' => '结果集。', 'type' => 'array', @@ -5000,35 +4587,17 @@ 'description' => '结果集。', 'type' => 'object', 'properties' => [ - 'QueryStartTime' => [ - 'description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', - 'type' => 'string', - 'example' => '2023-04-13 17:48:00', - ], - 'MaxQueryDurationMs' => [ - 'description' => '慢SQL执行的最大耗时，单位：ms，最小值为**1000**。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000', - ], - 'Cnt' => [ - 'description' => '当前时间内SQL总和。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'MinQueryDurationMs' => [ - 'description' => '慢SQL执行的最小耗时，单位：ms，最小值为**1000**。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'AvgQueryDurationMs' => [ - 'description' => '慢SQL执行的平均耗时，单位：ms，最小值为**1000**。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2000', - ], + 'QueryStartTime' => ['description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'example' => '2023-09-11 16:00:00'], + 'InitialQueryId' => ['description' => '查询ID。', 'type' => 'string', 'example' => '\'ae915a3ad30e77e67a7215d05b658cc6\''], + 'ReadRows' => ['description' => '读取行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'InitialAddress' => ['description' => '查询地址。', 'type' => 'string', 'example' => '0:0:0:0:0:ffff:1edd65ea'], + 'Query' => ['description' => '正在查询的语句。', 'type' => 'string', 'example' => 'select * from test'], + 'MemoryUsage' => ['description' => '查询内存使用峰值。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '4941696'], + 'Type' => ['description' => '慢日志类型。', 'type' => 'string', 'example' => 'ExceptionWhileProcessing'], + 'ReadBytes' => ['description' => '扫描数据大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '4507128020832'], + 'InitialUser' => ['description' => '查询用户。', 'type' => 'string', 'example' => 'bany'], + 'QueryDurationMs' => ['description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000'], + 'ResultBytes' => ['description' => '结果数据大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], ], ], ], @@ -5038,25 +4607,32 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-04-13 17:48:00\\",\\n \\"MaxQueryDurationMs\\": 3000,\\n \\"Cnt\\": 1,\\n \\"MinQueryDurationMs\\": 1000,\\n \\"AvgQueryDurationMs\\": 2000\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询慢日志趋势', - ], - 'DescribeSlowLogRecords' => [ - 'summary' => '调用DescribeSlowLogRecords接口查询慢日志明细。', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Cluster test\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-09-11 16:00:00\\",\\n \\"InitialQueryId\\": \\"\'ae915a3ad30e77e67a7215d05b658cc6\'\\",\\n \\"ReadRows\\": 10,\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"MemoryUsage\\": 4941696,\\n \\"Type\\": \\"ExceptionWhileProcessing\\",\\n \\"ReadBytes\\": 4507128020832,\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 3000,\\n \\"ResultBytes\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询慢日志明细', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DescribeSlowLogTrend' => [ + 'summary' => '调用DescribeSlowLogTrend接口查询慢日志趋势。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5065,133 +4641,63 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '186629', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '186604', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-09-11 16:00:00', - ], + 'schema' => ['description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-04-13 17:48:00'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', - 'type' => 'string', - 'required' => false, - 'example' => '2023-09-15 16:00:00', - ], + 'schema' => ['description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-06-07 10:03:00'], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', - 'schema' => [ - 'description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', - 'type' => 'string', - 'required' => false, - 'example' => '3000', - ], + 'schema' => ['description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', 'type' => 'string', 'required' => false, 'example' => '3000'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- 30（默认值）'."\n" - .'- 50'."\n" - .'- 100', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF'], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'DBInstanceID' => [ - 'description' => '集群ID。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => 'cc-bp100p4q1g9z32****', - ], - 'DBInstanceName' => [ - 'description' => '集群名称。', - 'type' => 'string', - 'example' => '集群测试', - ], - 'TotalCount' => [ - 'description' => '总记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z3****'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'Cluster test'], 'ResultSet' => [ 'description' => '结果集。', 'type' => 'array', @@ -5199,66 +4705,11 @@ 'description' => '结果集。', 'type' => 'object', 'properties' => [ - 'QueryStartTime' => [ - 'description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', - 'type' => 'string', - 'example' => '2023-09-11 16:00:00', - ], - 'InitialQueryId' => [ - 'description' => '查询ID。', - 'type' => 'string', - 'example' => '\'ae915a3ad30e77e67a7215d05b658cc6\'', - ], - 'ReadRows' => [ - 'description' => '读取行数。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'InitialAddress' => [ - 'description' => '查询地址。', - 'type' => 'string', - 'example' => '0:0:0:0:0:ffff:1edd65ea', - ], - 'Query' => [ - 'description' => '正在查询的语句。', - 'type' => 'string', - 'example' => 'select * from test', - ], - 'MemoryUsage' => [ - 'description' => '查询内存使用峰值。单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4941696', - ], - 'Type' => [ - 'description' => '慢日志类型。', - 'type' => 'string', - 'example' => 'ExceptionWhileProcessing', - ], - 'ReadBytes' => [ - 'description' => '扫描数据大小。单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4507128020832', - ], - 'InitialUser' => [ - 'description' => '查询用户。', - 'type' => 'string', - 'example' => 'bany', - ], - 'QueryDurationMs' => [ - 'description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000', - ], - 'ResultBytes' => [ - 'description' => '结果数据大小。单位：Byte。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'QueryStartTime' => ['description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'example' => '2023-04-13 17:48:00'], + 'MaxQueryDurationMs' => ['description' => '慢SQL执行的最大耗时，单位：ms，最小值为**1000**。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000'], + 'Cnt' => ['description' => '当前时间内SQL总和。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'MinQueryDurationMs' => ['description' => '慢SQL执行的最小耗时，单位：ms，最小值为**1000**。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], + 'AvgQueryDurationMs' => ['description' => '慢SQL执行的平均耗时，单位：ms，最小值为**1000**。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'], ], ], ], @@ -5268,25 +4719,32 @@ ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-09-11 16:00:00\\",\\n \\"InitialQueryId\\": \\"\'ae915a3ad30e77e67a7215d05b658cc6\'\\",\\n \\"ReadRows\\": 10,\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"MemoryUsage\\": 4941696,\\n \\"Type\\": \\"ExceptionWhileProcessing\\",\\n \\"ReadBytes\\": 4507128020832,\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 3000,\\n \\"ResultBytes\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询慢日志明细', - ], - 'ModifyBackupPolicy' => [ - 'summary' => '修改ClickHouse企业版集群的备份策略。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Cluster test\\",\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-04-13 17:48:00\\",\\n \\"MaxQueryDurationMs\\": 3000,\\n \\"Cnt\\": 1,\\n \\"MinQueryDurationMs\\": 1000,\\n \\"AvgQueryDurationMs\\": 2000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '查询慢日志趋势', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'DetachWhitelistTemplateToInstance' => [ + 'summary' => '取消白名单模板和实例关联关系', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5295,216 +4753,245 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '206399', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseIL81EM', - ], + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxx', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PreferredBackupTime', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '备份时间。', - 'type' => 'string', - 'required' => true, - 'example' => '15:00Z-16:00Z', - ], + 'schema' => ['title' => '白名单模板Id', 'description' => '白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca'], ], [ - 'name' => 'PreferredBackupPeriod', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '备份周期。', - 'type' => 'string', - 'required' => true, - 'example' => 'Monday', - ], - ], - [ - 'name' => 'BackupRetentionPeriod', - 'in' => 'query', - 'schema' => [ - 'description' => '备份保留天数。', - 'type' => 'string', - 'required' => false, - 'example' => '7', - ], + 'schema' => ['title' => '数据库实例名。逗号分隔，一次关联变更不超过20个', 'description' => 'ClickHouse实例ID。逗号分隔，一次关联变更不超过20个。', 'type' => 'string', 'required' => true, 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID。', 'type' => 'string', 'example' => '1234567890'], + 'Data' => [ + 'title' => '', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => ['title' => '操作状态。ok', 'description' => '操作状态。ok', 'type' => 'string', 'example' => 'ok'], + 'DetachFailList' => [ + 'title' => '解绑失败实例', + 'description' => '解绑失败实例。', + 'type' => 'array', + 'items' => [ + 'title' => '实例解绑失败详情', + 'description' => '实例解绑失败详情。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'my-database'], + 'Reason' => ['title' => '解绑失败原因', 'description' => '解绑失败原因。', 'type' => 'string', 'example' => '处理异常'], + ], + ], + ], + 'DetachSuccessedList' => [ + 'title' => '绑定成功模板', + 'description' => '绑定成功模板。', + 'type' => 'array', + 'items' => [ + 'title' => '实例绑定成功详情', + 'description' => '实例绑定成功详情。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例名称', 'description' => '实例名称。', 'type' => 'string', 'example' => 'my-database'], + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '白名单模板列表。', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '模板详情。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID。', 'type' => 'string', 'example' => 'g-asdfwem'], + 'TemplateName' => ['title' => '白名单模板名称', 'description' => '白名单模板名称。', 'type' => 'string', 'example' => 'demo_template'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'IP白名单列表。', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'description' => '关联的实例列表。', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'asdfwef'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''], + ['errorCode' => 'InvalidDBInstanceId.TooManyItems', 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', 'description' => ''], + ['errorCode' => 'InvalidParameter.DBInstanceId', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', 'description' => ''], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', - 'title' => '修改备份策略', - 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', - ], - 'DescribeBackupPolicy' => [ - 'summary' => '查看ClickHouse企业版集群的备份策略', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '取消白名单模板和实例关联关系', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:DetachWhitelistTemplateToInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"DetachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"DetachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetWhitelistTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '206399', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseIL81EM', - ], + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp100p4q1g9z3****', - ], + 'schema' => ['title' => 'RegionId', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '白名单模板Id', 'description' => '白名单模板ID。', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'PreferredBackupPeriod' => [ - 'description' => '备份周期。'."\n" - .'取值如下：'."\n" - ."\n" - .'- **Monday**：周一。'."\n" - .'- **Tuesday**：周二。'."\n" - .'- **Wednesday**：周三。'."\n" - .'- **Thursday**：周四。'."\n" - .'- **Friday**：周五。'."\n" - .'- **Saturday**：周六。'."\n" - .'- **Sunday**：周日。', - 'type' => 'string', - 'example' => 'Monday', - ], - 'Switch' => [ - 'description' => '是否开启备份。'."\n" - .'取值如下：'."\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' => '备份保留天数。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'BackupSize' => [ - 'description' => '备份文件大小。'."\n" - .'单位：MB。', - 'type' => 'string', - 'example' => '123124', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID。', 'type' => 'string', 'example' => '1234567890'], + 'Data' => [ + 'title' => '', + 'description' => '白名单模板详情。', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '白名单模板列表。', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '模板详情。', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID。', 'type' => 'string', 'example' => 'g-asdfwem'], + 'TemplateName' => ['title' => '白名单模板名称', 'description' => '白名单模板名称。', 'type' => 'string', 'example' => 'demo_template'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'IP白名单列表。', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'description' => '关联的实例列表。', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'description' => '实例详情。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'cc-asdfwef'], + ], + ], + ], + ], + ], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","type":"json"}]', - 'title' => '查看备份策略', - ], - 'DeleteBackupPolicy' => [ - 'summary' => '删除ClickHouse企业版集群的备份策略。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '查询白名单模板详情', + 'summary' => '查询白名单模板详情', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:GetWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'KillProcess' => [ + 'summary' => '调用KillProcess接口终止正在进行的任务。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5516,269 +5003,427 @@ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '206399', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseN8BUWF', - ], + 'abilityTreeCode' => '186648', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-xxxxx', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxxxx'], ], [ - 'name' => 'RegionId', + 'name' => 'InitialQueryId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '查询ID。', 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => ['description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-gs5j3sua77******-clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => '60DDD29D-E5A8-563C-88FB-06D3A1F1C609', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxxxxx'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'cc-xxxxxxx'."\n"], + 'Count' => ['description' => '结束任务数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60DDD29D-E5A8-563C-88FB-06D3A1F1C609\\"\\n}","type":"json"}]', - 'title' => '删除备份策略', - ], - 'CreateBackupPolicy' => [ - 'summary' => '为指定的ClickHouse企业版集群创建备份策略。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"Count\\": 1\\n }\\n}","type":"json"}]', + 'title' => '终止正在进行的任务', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:KillProcess', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ListClickHouseDBTimezones' => [ + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '206399', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseIL81EM', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-2ze0eb0w182xh8549', - ], + 'schema' => ['description' => '每页记录数，取值：'."\n" + .'- **30**（默认值）'."\n" + .'- **50**'."\n" + .'- **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '10'], ], [ - 'name' => 'RegionId', + 'name' => 'PageNumber', 'in' => 'query', + 'schema' => ['description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], + 'TimeZones' => [ + 'description' => 'ClickHouse支持的时区枚举值列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['description' => '时区枚举值。', 'type' => 'string', 'example' => 'Asia/Shanghai'], + ], + 'description' => '', + ], + ], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '获取ClickHouse时区枚举值列表', + 'summary' => '列举ClickHouse时区参数枚举值', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"TimeZones\\": [\\n {\\n \\"ZoneId\\": \\"Asia/Shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListInstanceLinkedWhitelistTemplates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PreferredBackupTime', - 'in' => 'query', - 'schema' => [ - 'description' => '执行备份的`UTC`时间范围。'."\n" - .'例如`12:00Z-13:00Z`，则表示将在`UTC`时间的`12:00`到`13:00`之间开始执行备份。', - 'type' => 'string', - 'required' => true, - 'example' => '10:00Z-11:00Z', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ [ - 'name' => 'PreferredBackupPeriod', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '备份周期。'."\n" - .'指定每周备份日期，多个日期需用英文逗号`,`隔开。', - 'type' => 'string', - 'required' => true, - 'example' => 'Monday,Friday', - ], + 'schema' => ['title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'BackupRetentionPeriod', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '备份保留天数。', - 'type' => 'string', - 'required' => false, - 'example' => '8', - ], + 'schema' => ['title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'cc-exadfas'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '请求ID。', - 'type' => 'string', - 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890'], + 'Data' => [ + 'title' => '白名单模板清单结果', + 'description' => '白名单模板清单结果', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem'], + 'TemplateName' => ['title' => '白名单模板名称', 'description' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], + ], + ], + ], + ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', - 'title' => '创建备份策略', - ], - 'DescribeBackups' => [ - 'summary' => '查询ClickHouse企业版集群的备份集。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '查询实例关联的白名单模板', + 'summary' => '查询实例关联的白名单模板清单', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:ListInstanceLinkedWhitelistTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListWhitelistTemplates' => [ + 'summary' => '查询实例关联的白名单模板清单', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '206399', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseIL81EM', - ], + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ - 'name' => 'DBInstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1v9kq45u0o80cvh', - ], + 'schema' => ['title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'RegionId', + 'name' => 'TemplateName', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['title' => '模板名称，支持模糊查询', 'description' => '模板名称，支持模糊查询', 'type' => 'string', 'required' => false, 'example' => 'default'], ], [ - 'name' => 'BackupId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '备份记录ID。', - 'type' => 'string', - 'required' => false, - 'example' => '117403****', - ], + 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'StartTime', + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['title' => '每页记录数量', 'description' => '每页记录数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '25', 'default' => '25'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '备份开始时间，UTC时间。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-11-21T16:00Z', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890'], + 'Data' => [ + 'title' => '白名单模板清单结果', + 'description' => '白名单模板清单结果', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], + 'PageSize' => ['title' => '分页数量', 'description' => '分页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'CurrPageNumbers' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalPageNumbers' => ['title' => '总页码', 'description' => '总页码', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'HasPrev' => ['title' => '是否有前一页', 'description' => '是否有前一页', 'type' => 'boolean', 'example' => 'false'], + 'HasNext' => ['title' => '是否有后一页', 'description' => '是否有后一页', 'type' => 'boolean', 'example' => 'true'], + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem'], + 'TemplateName' => ['title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'description' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'description' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'cc-asdfwef'], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '查询实例关联的白名单模板', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:ListWhitelistTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 30,\\n \\"PageSize\\": 20,\\n \\"CurrPageNumbers\\": 1,\\n \\"TotalPageNumbers\\": 2,\\n \\"HasPrev\\": false,\\n \\"HasNext\\": true,\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"g-asdfwem\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ModifyAccountAuthority' => [ + 'summary' => '调用ModifyAccountAuthority接口修改账号的授权信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EndTime', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185304', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '备份结束时间，UTC时间。', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-11-25T16:00Z', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PageSize', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '30', - 'example' => '30', - 'default' => '30', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], [ - 'name' => 'PageNumber', + 'name' => 'Account', + 'in' => 'query', + 'schema' => ['description' => '数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'test1'], + ], + [ + 'name' => 'DmlAuthSetting', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '页码。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', + 'description' => '授权信息。', + 'type' => 'object', + 'properties' => [ + 'DmlAuthority' => [ + 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" + ."\n" + .'- **0**：Read，Write，and Change settings queries are allowed.'."\n" + ."\n" + .'- **1**：Only Read data queries are allowed.'."\n" + ."\n" + .'- **2**：Read data and Change settings queries are allowed.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + 'enum' => ['0', '1', '2'], + ], + 'DdlAuthority' => ['description' => '是否授予数据库账号DDL权限，取值说明：'."\n" + ."\n" + .'- **true**：允许DDL。'."\n" + .'- **false**：禁止DDL。', 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'AllowDictionaries' => [ + 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', + 'type' => 'array', + 'items' => ['description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'db1,db2'], + 'required' => false, + ], + 'AllowDatabases' => [ + 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', + 'type' => 'array', + 'items' => ['description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'db1,db2'], + 'required' => false, + ], + ], + 'required' => true, ], ], ], @@ -5786,117 +5431,56 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '返回结果。', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '备份总个数。', - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '每页记录数。', - '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' => [ - 'description' => '备份集列表。', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'description' => '集群ID。', - 'type' => 'string', - 'example' => 'cc-bp179i5956tih2m93', - ], - 'BackupStatus' => [ - 'description' => '备份集状态。', - 'type' => 'string', - 'example' => 'Success', - ], - 'BackupType' => [ - 'description' => '备份类型。'."\n" - .'取值如下：'."\n" - ."\n" - .'- **FullBackup**：全量备份。'."\n" - .'- **IncrementalBackup**：增量备份。', - 'type' => 'string', - 'example' => 'IncrementalBackup', - ], - 'BackupStartTime' => [ - 'description' => '备份开始时间。', - 'type' => 'string', - 'example' => '2021-11-22T18:28:22Z', - ], - 'BackupSize' => [ - 'description' => '备份文件大小，单位MB。', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '131072', - ], - 'BackupEndTime' => [ - 'description' => '本次备份结束时间，UTC时间。', - 'type' => 'string', - 'example' => '2021-11-22T18:28:41Z', - ], - 'BackupSetInfo' => [ - 'description' => '备份集信息。', - 'type' => 'string', - 'example' => '{"shard_count": 4}', - ], - 'BackupId' => [ - 'description' => '备份记录ID。', - 'type' => 'string', - 'example' => '117403****', - ], - 'BackupMethod' => [ - 'description' => '备份方法。', - 'type' => 'string', - 'example' => 'Physical', - ], - 'ExpireDate' => [ - 'description' => '备份集过期时间。', - 'type' => 'string', - 'example' => '2022-07-22T18:28:41Z', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Account' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'test1'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-bp179i5956tih2m93\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '查看备份集', - ], - 'ModifyDBInstanceConfig' => [ - 'summary' => '修改实例参数配置', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '修改账号的授权信息', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyAccountDescription' => [ + 'summary' => '调用ModifyAccountDescription接口修改账号的备注信息。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5905,171 +5489,371 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '206399', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'abilityTreeCode' => '185303', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-uf6lkzf*****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1anv7jo84t****'], ], [ - 'name' => 'RegionId', + 'name' => 'Account', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '账号名称', 'type' => 'string', 'required' => true, 'example' => 'testuser'], ], [ - 'name' => 'Parameters', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'JSON格式的API数据参数配置。', - 'type' => 'string', - 'required' => false, - 'example' => '{"max_concurrent_queries":"100"}', - ], + 'schema' => ['description' => '账号备注。', 'type' => 'string', 'required' => true, 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '05321590-BB65-4720-8C***********', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7FFC9EBE-5023-5D5D-A5F0-1607E0F2****'], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'cc-uf6lkzf*****'."\n", - ], + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp1anv7jo84t****'], + 'Account' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'testuser'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8C***********\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-uf6lkzf*****\\\\n\\"\\n }\\n}","type":"json"}]', - 'title' => '修改实例配置', - ], - 'DescribeDBInstanceConfigChangeLog' => [ - 'summary' => '查询实例参数配置记录', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '修改账号备注', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FFC9EBE-5023-5D5D-A5F0-1607E0F2****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp1anv7jo84t****\\",\\n \\"Account\\": \\"testuser\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyBackupPolicy' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'abilityTreeCode' => '206401', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => ['FEATUREclickhouseIL81EM'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-uf6lkzf*****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx'], ], [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing'], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => ['description' => '备份时间。', 'type' => 'string', 'required' => true, 'example' => '15:00Z-16:00Z'], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => ['description' => '备份周期。', 'type' => 'string', 'required' => true, 'example' => 'Monday'], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => ['description' => '备份保留天数。', 'type' => 'string', 'required' => false, 'example' => '7'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-shanghai', + 'title' => 'Schema of Response', + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'StorageTypeDoNotSupportBackup', 'errorMessage' => 'Current StorageType Does Not Support Backup.', 'description' => '当前存储类型不支持备份'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改备份策略', + 'summary' => '修改ClickHouse企业版集群的备份策略。', + 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceAttribute' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'StartTime', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx'], + ], + [ + 'name' => 'AttributeType', 'in' => 'query', 'schema' => [ - 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss 。', + 'description' => '需要修改的类型。'."\n" + .'- MaintainTime：修改运维时间'."\n" + .'- DBInstanceDescription：修改实例名称', 'type' => 'string', 'required' => true, - 'example' => '2025-01-01 10:00:00', + 'enumValueTitles' => [], + 'example' => 'DBInstanceDescription', + 'enum' => ['MaintainTime', 'DBInstanceDescription'], ], ], [ - 'name' => 'EndTime', + 'name' => 'AttributeValue', + 'in' => 'query', + 'schema' => ['description' => '需要修改的内容。', 'type' => 'string', 'required' => true, 'example' => 'test'], + ], + [ + 'name' => 'Product', 'in' => 'query', + 'schema' => ['description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss 。', - 'type' => 'string', - 'required' => true, - 'example' => '2025-01-01 10:00:00'."\n", + 'title' => 'Schema of Response', + 'description' => '返回参数详情。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => '修改集群的配置属性', + 'summary' => '调用ModifyDBInstanceAttribute接口修改集群的配置属性。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', + ], + 'ModifyDBInstanceClass' => [ + 'summary' => '调用ModifyDBInstanceClass接口修改集群的弹性配置。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188578', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-gs5j3sua77*******'], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => ['title' => '（参数废弃）serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8'], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => ['title' => '（参数废弃）serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32'], + ], + [ + 'name' => 'NodeScaleMax', + 'in' => 'query', + 'schema' => ['title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'description' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '4'], + ], + [ + 'name' => 'NodeScaleMin', + 'in' => 'query', + 'schema' => ['title' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'description' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '32'], + ], + [ + 'name' => 'NodeCount', + 'in' => 'query', + 'schema' => ['title' => '节点个数，取值范围2-16', 'description' => '节点个数，取值范围2-16', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64', 'minimum' => '1', 'example' => '2'], + ], + [ + 'name' => 'StorageQuota', + 'in' => 'query', + 'schema' => ['description' => '存储预购量（GB）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '100'], + ], + [ + 'name' => 'StorageType', 'in' => 'query', 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'title' => '存储类型。', + 'description' => '存储类型。', + 'type' => 'string', 'required' => false, - 'example' => '30', - 'default' => '30', + 'example' => 'OSS', + 'enum' => ['oss', 'ESSD_L1', 'ESSD_L2', 'ESSD_L3', 'SSD', 'ESSD_L0'], ], ], [ - 'name' => 'PageNumber', + 'name' => 'ComputingGroupId', 'in' => 'query', + 'schema' => ['title' => '计算组id', 'description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-gs5j3sua77*******-clickhouse'], + ], + [ + 'name' => 'AutoScaleConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '当前页码。', - 'type' => 'integer', - 'format' => 'int32', + 'title' => '自动水平弹性配置', + 'description' => '自动水平弹性配置', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '配置状态，disable关闭，enable开启', + 'description' => '配置状态，disable关闭，enable开启', + 'type' => 'string', + 'required' => false, + 'example' => 'enable', + 'enum' => ['enable', 'disable'], + ], + 'BurstNum' => ['title' => '可burst水平弹性数量', 'description' => '可burst水平弹性数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64', 'minimum' => '1', 'example' => '2'], + 'VSwitchInfos' => [ + 'title' => 'vSwitch信息', + 'description' => 'vSwitch信息', + 'type' => 'array', + 'items' => [ + 'title' => 'vSwitch信息', + 'description' => 'vSwitch信息', + 'type' => 'object', + 'properties' => [ + 'ZoneId' => ['title' => '热池可用区', 'description' => '热池可用区', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing-XXX'], + 'VSwitchIds' => [ + 'title' => '可用区下的vSwitchId', + 'description' => '可用区下的vSwitchId', + 'type' => 'array', + 'items' => ['title' => 'vSwitchId', 'description' => 'vSwitchId', 'type' => 'string', 'required' => false, 'example' => 'vsw-XXXXX'], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + 'minItems' => 0, + ], + ], 'required' => false, - 'example' => '1', - 'default' => '1', ], ], ], @@ -6077,135 +5861,94 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '780DE414-*********-88BE-A2E21B862B57', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], 'Data' => [ - 'description' => '查询结果集。', + 'title' => '返回数据。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'ParamChangeLogs' => [ - 'description' => '参数变更记录。', - 'type' => 'array', - 'items' => [ - 'description' => '参数变更记录。', - 'type' => 'object', - 'properties' => [ - 'ID' => [ - 'description' => '操作ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Name' => [ - 'description' => '参数名称。', - 'type' => 'string', - 'example' => 'max_concurrent_queries', - ], - 'OldValue' => [ - 'description' => ' '."\n" - .'旧参数值。', - 'type' => 'string', - 'example' => '50', - ], - 'NewValue' => [ - 'description' => ' '."\n" - .'新参数值。', - 'type' => 'string', - 'example' => '100', - ], - 'Applied' => [ - 'description' => '配置是否生效：'."\n" - ."\n" - .'- true：生效'."\n" - ."\n" - .'- false：不生效', - 'type' => 'boolean', - ], - 'GmtCreated' => [ - 'description' => '变更创建时间。', - 'type' => 'string', - 'example' => '2025-06-25 13:46:06', - ], - 'GmtModified' => [ - 'description' => '变更修改时间。', - 'type' => 'string', - 'example' => '2025-06-25 13:46:06'."\n", - ], - ], - ], - ], + 'TaskId' => ['title' => '任务ID。', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000****'], + 'ScaleMin' => ['title' => 'serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], + 'ScaleMax' => ['title' => 'serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], + 'DBInstanceID' => ['title' => '集群ID。', 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-gs5j3sua77*******'], + 'DBInstanceName' => ['title' => '集群名称。', 'description' => '集群名称。', 'type' => 'string', 'example' => 'cc-gs5j3sua77*******'], + 'ComputingGroupId' => ['description' => '计算组ID。', 'type' => 'string', 'example' => 'cc-gs5j3sua77*******-clickhouse'], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidSpecification', 'errorMessage' => 'Specification parameter is not valid.', 'description' => '规格参数无效。'], + ['errorCode' => 'InvalidDBInstanceStatus', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => '实例状态不允许当前操作。'], + ['errorCode' => 'OperationDenied.OrderProcessing', 'errorMessage' => 'The operation is not permitted due to there is an order in processing of cluster.', 'description' => '存在未完成的订单，请稍后再试。'], + ['errorCode' => 'OperationDenied.NothingChanged', 'errorMessage' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.', 'description' => '实例操作变更配置，但传入配置与当前配置相同，没有任何改变。'], + ['errorCode' => 'ForbiddenRegisterAutoScaleConfig', 'errorMessage' => 'Can\'t register autoScale config', 'description' => ''], + ['errorCode' => 'InvalidAutoScaleConfig', 'errorMessage' => 'The autoScale config is invalid, param error', 'description' => ''], + ['errorCode' => 'UnsupportedAutoScaleZone', 'errorMessage' => 'ZoneId is null or the specified zone is not supported for autoScale', 'description' => ''], + ], ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"780DE414-*********-88BE-A2E21B862B57\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"ParamChangeLogs\\": [\\n {\\n \\"ID\\": 1,\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"OldValue\\": \\"50\\",\\n \\"NewValue\\": \\"100\\",\\n \\"Applied\\": true,\\n \\"GmtCreated\\": \\"2025-06-25 13:46:06\\",\\n \\"GmtModified\\": \\"2025-06-25 13:46:06\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询实例参数变更记录', - ], - 'DescribeDBInstanceConfig' => [ - 'summary' => '查询实例参数配置', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"ScaleMin\\": 2,\\n \\"ScaleMax\\": 32,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-gs5j3sua77*******\\",\\n \\"ComputingGroupId\\": \\"cc-gs5j3sua77*******-clickhouse\\"\\n }\\n}","type":"json"}]', + 'title' => '修改集群弹性配置', + 'description' => '请确保在使用该接口前，已充分了解云数据库 ClickHouse 产品的收费方式和[价格](~~167450~~)。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ModifyDBInstanceConfig' => [ + 'summary' => '修改实例参数配置', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '204414', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-wz9go4x*****', - ], + 'schema' => ['description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-uf6lkzf*****'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '地域ID。', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => ['description' => 'JSON格式的API数据参数配置。', 'type' => 'string', 'required' => false, 'example' => '{"max_concurrent_queries":"100"}'], ], ], 'responses' => [ @@ -6215,270 +5958,195 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05321590-BB65-4720-8C***********'], 'Data' => [ - 'description' => '返回结果。', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'description' => '实例ID。', - 'type' => 'string', - 'example' => 'cc-bp100p4q1g9z3****', - ], - 'Params' => [ - 'description' => '用户参数。', - 'type' => 'array', - 'items' => [ - 'description' => '用户参数。', - 'type' => 'object', - 'properties' => [ - 'IsDynamic' => [ - 'description' => '是否动态生效（不需要重启）。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IsUserModifiable' => [ - 'description' => '用户是否可修改。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DefaultValue' => [ - 'description' => '参数默认值。', - 'type' => 'string', - 'example' => '1', - ], - 'Name' => [ - 'description' => '参数名。', - 'type' => 'string', - 'example' => 'max_concurrent_queries', - ], - 'Optional' => [ - 'description' => '参数取值范围。', - 'type' => 'string', - 'example' => '[0-100]', - ], - 'Comment' => [ - 'description' => '参数备注信息。', - 'type' => 'string', - 'example' => 'Maximum number of concurrently executed queries. Zero means unlimited.', - ], - 'ParamRelyRule' => [ - 'description' => '参数依赖。', - 'type' => 'string', - 'example' => '0', - ], - 'Value' => [ - 'description' => '参数值。', - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], + 'DBInstanceId' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'cc-uf6lkzf*****'."\n"], ], ], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Params\\": [\\n {\\n \\"IsDynamic\\": 1,\\n \\"IsUserModifiable\\": 1,\\n \\"DefaultValue\\": \\"1\\",\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"Optional\\": \\"[0-100]\\",\\n \\"Comment\\": \\"Maximum number of concurrently executed queries. Zero means unlimited.\\",\\n \\"ParamRelyRule\\": \\"0\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '查询实例参数配置', - ], - 'ChangeResourceGroup' => [ - 'summary' => '修改ClickHouse企业版实例所在资源组。', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => '修改实例配置', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8C***********\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-uf6lkzf*****\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => '调用ModifyDBInstanceConnectionString接口修改集群的连接地址。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeCode' => '163948', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '186649', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ResourceType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '资源类型', - 'description' => '资源类型', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'EnterpriseDBCluster', - 'default' => 'EnterpriseDBCluster', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ResourceId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '资源Id', - 'description' => '资源Id', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-bp1i43033051****', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx'], ], [ - 'name' => 'ResourceRegionId', + 'name' => 'ConnectionString', 'in' => 'query', - 'schema' => [ - 'title' => '地域Id', - 'description' => '地域Id', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '连接地址。', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => ['description' => '连接数据库的地址前辍。', 'type' => 'string', 'required' => false, 'example' => 'cc-****-clickhouse'], + ], + [ + 'name' => 'DisablePorts', + 'in' => 'query', + 'schema' => ['description' => '- 禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。'."\n" + .'- 仅内核版本大于等于24.10.1.11098_1的集群支持此参数。'."\n" + .'><notice>集群创建时其版本低于24.10.1.11098_1，后期升级到24.10.1.11098_1版本及以上的版本，不支持此参数。</notice>', 'type' => 'string', 'required' => false, 'example' => '9001,8123'], + ], + [ + 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ - 'title' => '目标资源组', - 'description' => '目标资源组', + 'description' => '网络类型，取值范围如下：'."\n" + ."\n" + .'- Vpc：Vpc网络'."\n" + .'- Public：公网', 'type' => 'string', - 'required' => true, - 'example' => 'rg-4690g37929****', + 'required' => false, + 'enumValueTitles' => ['Vpc' => 'Vpc', 'Public' => 'Public'], + 'example' => 'Public', + 'enum' => ['Public'], ], ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => ['description' => '计算组Id。', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze34****-clickhouse'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'C342F3DD-1FF7-55E9-A1A1-098D*******', + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxxx'], + 'ConnectionString' => ['description' => '连接地址。', 'type' => 'string', 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'cc-xxxxx'], + 'DisabledPorts' => ['description' => '已经禁用的数据库端口。', 'type' => 'string', 'example' => '9001,8123'], + ], ], ], ], ], ], - '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', - ], - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098D*******\\"\\n}","type":"json"}]', - 'title' => '修改ClickHouse企业版实例所在资源组', - ], - 'ListClickHouseDBTimezones' => [ - 'summary' => '列举ClickHouse时区参数枚举值', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"ConnectionString\\": \\"cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"cc-xxxxx\\",\\n \\"DisabledPorts\\": \\"9001,8123\\"\\n }\\n}","type":"json"}]', + 'title' => '修改连接地址', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceConnectionString', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'ModifyLangfuseOrgMembership' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseFBPCH8', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '每页记录数，取值：'."\n" - .'- **30**（默认值）'."\n" - .'- **50**'."\n" - .'- **100**'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - 'default' => '10', - ], + 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'PageNumber', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '页数。', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], + ], + [ + 'name' => 'OrganizationId', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => ['description' => '用户在组织中的角色', 'type' => 'string', 'required' => true, 'example' => 'ADMIN'], ], ], 'responses' => [ @@ -6488,24 +6156,13 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', - ], - 'TimeZones' => [ - 'description' => 'ClickHouse支持的时区枚举值列表。', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ZoneId' => [ - 'description' => '时区枚举值。', - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Role' => ['description' => '用户在组织中的角色', 'type' => 'string', 'example' => 'ADMIN'], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], ], ], ], @@ -6513,28 +6170,24 @@ ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"TimeZones\\": [\\n {\\n \\"ZoneId\\": \\"Asia/Shanghai\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => '获取ClickHouse时区枚举值列表', + 'title' => '修改用户在Langfuse组织中的权限', + 'summary' => '修改用户在Langfuse组织中的权限', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"Role\\": \\"ADMIN\\",\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]', ], - 'DeleteWhitelistTemplate' => [ - 'summary' => '删除白名单模板', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ModifyLangfuseProjectMembership' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6543,95 +6196,59 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'TemplateId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '白名单模板Id', - 'type' => 'string', - 'required' => true, - 'example' => '98a6d3db05984dca', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'TemplateName', + 'name' => 'OrganizationId', 'in' => 'query', - 'schema' => [ - 'title' => '白名单模板Id', - 'type' => 'string', - 'example' => '98a6d3db05984dca', - ], + 'schema' => ['description' => 'Langfuse组织ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'Langfuse项目ID', 'type' => 'string', 'required' => true, 'example' => 'cmrbhzx930005jw2q****'], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], + ], + [ + 'name' => 'Role', + 'in' => 'query', + 'schema' => ['description' => '用户在项目中的角色', 'type' => 'string', 'required' => true, 'example' => 'VIEWER'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], 'Data' => [ - 'title' => '', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Templates' => [ - 'title' => '白名单模板列表', - 'type' => 'array', - 'items' => [ - 'title' => '模板详情', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], - 'DbInstances' => [ - 'title' => '关联的实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '实例详情', - 'type' => 'object', - 'properties' => [ - 'DbInstanceName' => [ - 'title' => '实例ID', - 'type' => 'string', - 'example' => 'asdfwef', - ], - ], - ], - ], - ], - ], - ], + 'Role' => ['description' => '用户在项目中的角色', 'type' => 'string', 'example' => 'VIEWER'], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], ], ], ], @@ -6639,39 +6256,25 @@ ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplateId', - 'errorMessage' => 'Invalid Whitelist templateId.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', - 'errorMessage' => 'No permission to operate the whitelist template.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '未找到有效实例'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '', + 'title' => '修改用户在Langfuse项目中的权限', + 'summary' => '修改用户在Langfuse项目中的权限', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"Role\\": \\"VIEWER\\",\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]', ], - 'CreateWhitelistTemplate' => [ - 'summary' => '新增白名单模板', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ModifySecurityIPList' => [ + 'summary' => '调用ModifySecurityIPList接口变更集群白名单设置。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6680,98 +6283,64 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], - 'tenantRelevance' => 'publicInformation', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing'], ], [ - 'name' => 'TemplateName', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '白名单模板名称', - 'description' => '白名单模板名称', - 'type' => 'string', - 'required' => true, - 'example' => 'InvoiceTemplate', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx'], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => '操作的分组名称。', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'SecurityIPList', - 'in' => 'formData', - 'schema' => [ - 'title' => '白名单列表. 逗号分隔，数量不超过100个。', - 'description' => '白名单列表。基于逗号分隔，数量不超过100个。', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.1.1,10.0.0.1', - ], + 'in' => 'query', + 'schema' => ['description' => '白名单IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.0/24,172.16.0.0/24'], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => ['description' => '修改模式。'."\n" + .'- 0：覆盖修改'."\n" + .'- 1：增加'."\n" + .'- 2：删除'."\n" + ."\n" + .'> 建议固定指定0进行覆盖修改', 'type' => 'string', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx'], 'Data' => [ - 'title' => '', - 'description' => '返回数据', + 'description' => '返回数据。', 'type' => 'object', 'properties' => [ - 'Templates' => [ - 'title' => '白名单模板列表', - 'description' => '白名单模板列表', - 'type' => 'array', - 'items' => [ - 'title' => '模板详情', - 'description' => '模板详情', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'description' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'TemplateName' => [ - 'title' => '白名单模板名称', - 'description' => '白名单模板名称', - 'type' => 'string', - 'example' => 'demo_template', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'description' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], - ], - ], - ], + 'GroupName' => ['description' => '分组名称。', 'type' => 'string', 'example' => 'test'], + 'SecurityIPType' => ['description' => 'IP地址类型。', 'type' => 'string', 'example' => 'ipv4'], + 'GroupTag' => ['description' => '分组标签。', 'type' => 'string', 'example' => 'test'], + 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SecurityIPList' => ['description' => '白名单分组下的IP列表。', 'type' => 'string', 'example' => '192.168.0.0/24,172.16.0.0/24'], + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxx'], + 'WhitelistNetType' => ['description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'cc-xxxx'], ], ], ], @@ -6779,64 +6348,35 @@ ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidSecurityIPs.Malformed', - 'errorMessage' => 'Specified IPList is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplateName.Duplicated', - 'errorMessage' => 'Whitelist template name duplicated.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', - 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Format', - 'errorMessage' => 'Specified security IP list format is not valid.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplateName.CreateLimit', - 'errorMessage' => 'Created Whitelist template name exceeded limit.', - ], - [ - 'errorCode' => 'InvalidIpWhitelistTemplateName.Malformed', - 'errorMessage' => 'The templateName is not valid.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.Duplicate', - 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', - ], - [ - 'errorCode' => 'InvalidUser.NotFound', - 'errorMessage' => 'Specified user does not exist.', - ], + 404 => [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '创建白名单模板', - ], - 'DetachWhitelistTemplateToInstance' => [ - 'summary' => '取消白名单模板和实例关联关系', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '变更白名单', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifySecurityIPList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"TaskId\\": 1,\\n \\"SecurityIPList\\": \\"192.168.0.0/24,172.16.0.0/24\\",\\n \\"DBInstanceID\\": 0,\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"cc-xxxx\\"\\n }\\n}","type":"json"}]', + ], + 'ResetAccountPassword' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6848,138 +6388,54 @@ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '185276', + 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], ], 'parameters' => [ [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'TemplateId', + 'name' => 'Account', 'in' => 'query', - 'schema' => [ - 'title' => '白名单模板Id', - 'type' => 'string', - 'required' => true, - 'example' => '98a6d3db05984dca', - ], + 'schema' => ['description' => '数据库账号名称。', 'type' => 'string', 'required' => true, 'example' => 'test1'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'Password', 'in' => 'query', - 'schema' => [ - 'title' => '数据库实例名。逗号分隔，一次关联变更不超过20个', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', - ], + 'schema' => ['description' => '数据库账号的密码。'."\n" + ."\n" + .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" + .'- !@#$%^&*()_+-=为特殊字符。'."\n" + .'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => '123456Aa'], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => ['description' => '产品名称。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A6A077A-577C-536E-AC13-8E715D7A34C8'], 'Data' => [ - 'title' => '', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作状态。ok', - 'type' => 'string', - 'example' => 'ok', - ], - 'DetachFailList' => [ - 'title' => '解绑失败实例', - 'type' => 'array', - 'items' => [ - 'title' => '实例解绑失败详情', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例名称', - 'type' => 'string', - 'example' => 'my-database', - ], - 'Reason' => [ - 'title' => '解绑失败原因', - 'type' => 'string', - 'example' => '处理异常', - ], - ], - ], - ], - 'DetachSuccessedList' => [ - 'title' => '绑定成功模板', - 'type' => 'array', - 'items' => [ - 'title' => '实例绑定成功详情', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例名称', - 'type' => 'string', - 'example' => 'my-database', - ], - 'Templates' => [ - 'title' => '白名单模板列表', - 'type' => 'array', - 'items' => [ - 'title' => '模板详情', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'TemplateName' => [ - 'title' => '白名单模板名称', - 'type' => 'string', - 'example' => 'demo_template', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], - 'DbInstances' => [ - 'title' => '关联的实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '实例详情', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例ID', - 'type' => 'string', - 'example' => 'asdfwef', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'DBInstanceId' => ['description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****'], + 'Account' => ['description' => '数据库账号。', 'type' => 'string', 'example' => 'test1'], ], ], ], @@ -6987,46 +6443,39 @@ ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplateId', - 'errorMessage' => 'Invalid Whitelist templateId.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', - 'errorMessage' => 'No permission to operate the whitelist template.', - ], - [ - 'errorCode' => 'InvalidDBInstanceId.TooManyItems', - 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', - ], - [ - 'errorCode' => 'InvalidParameter.DBInstanceId', - 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', - ], + 403 => [ + ['errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', 'description' => ''], + ], + [ + ['errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', 'description' => '传入的实例ID不存在。'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - ], - 'UpdateWhitelistTemplate' => [ - 'summary' => '更新白名单模板', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '重置账号的密码', + 'summary' => '调用ResetAccountPassword接口重置云数据库ClickHouse企业版集群的数据库账号密码。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ResetAccountPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6A077A-577C-536E-AC13-8E715D7A34C8\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + ], + 'ResetLangfuseUserPassword' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7037,104 +6486,53 @@ 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'chargeType' => 'paid', + 'abilityTreeCode' => '182031', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '地域id', 'description' => '地域id', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'TemplateId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '白名单模板Id', - 'type' => 'string', - 'required' => true, - 'example' => '98a6d3db05984dca', - ], + 'schema' => ['description' => 'Langfuse实例ID', 'type' => 'string', 'required' => true, 'example' => 'lfs-****'], ], [ - 'name' => 'TemplateName', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'title' => '白名单模板Id', - 'type' => 'string', - 'required' => true, - 'example' => '98a6d3db05984dca', - ], + 'schema' => ['description' => '用户电子邮箱', 'type' => 'string', 'required' => true, 'example' => 'john@company.com'], ], [ - 'name' => 'SecurityIPList', + 'name' => 'NewPassword', 'in' => 'query', - 'schema' => [ - 'title' => '白名单列表. 逗号分隔，数量不超过100个。', - 'type' => 'string', - 'required' => true, - 'example' => '192.168.1.1,10.0.0.1', - ], + 'schema' => ['description' => '新的用户密码，设置规则如下：'."\n" + ."\n" + .'由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" + ."\n" + .'!@#$%^&*()_+-=为特殊字符。'."\n" + ."\n" + .'长度为 8~32 个字符。', 'type' => 'string', 'required' => true, 'example' => '2F9e9@******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'Data' => [ - 'title' => '', + 'title' => '返回结果。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'Templates' => [ - 'title' => '白名单模板列表', - 'type' => 'array', - 'items' => [ - 'title' => '模板详情', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], - 'DbInstances' => [ - 'title' => '关联的实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '实例详情', - 'type' => 'object', - 'properties' => [ - 'DbInstanceName' => [ - 'title' => '实例ID', - 'type' => 'string', - 'example' => 'asdfwef', - ], - ], - ], - ], - ], - ], - ], + 'Email' => ['description' => '用户电子邮箱', 'type' => 'string', 'example' => 'john@company.com'], ], ], ], @@ -7143,226 +6541,188 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidSecurityIPs.Malformed', - 'errorMessage' => 'Specified IPList is not valid.', - ], - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplateId', - 'errorMessage' => 'Invalid Whitelist templateId.', - ], - [ - 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', - 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', - 'errorMessage' => 'No permission to operate the whitelist template.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - ], - 'GetWhitelistTemplate' => [ - 'summary' => '查询白名单模板详情', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], + 'title' => '重置Langfuse用户密码', + 'summary' => '重置Langfuse用户密码', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"Email\\": \\"john@company.com\\"\\n }\\n}","type":"json"}]', + ], + 'RestartDBInstance' => [ + 'summary' => '调用RestartDBInstance接口重启云数据库ClickHouse企业版集群。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '192305', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'TemplateId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '白名单模板Id', - 'type' => 'string', - 'required' => true, - 'example' => '98a6d3db05984dca', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], 'Data' => [ - 'title' => '', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'Templates' => [ - 'title' => '白名单模板列表', - 'type' => 'array', - 'items' => [ - 'title' => '模板详情', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'TemplateName' => [ - 'title' => '白名单模板名称', - 'type' => 'string', - 'example' => 'demo_template', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], - 'DbInstances' => [ - 'title' => '关联的实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '实例详情', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例ID', - 'type' => 'string', - 'example' => 'cc-asdfwef', - ], - ], - ], - ], - ], - ], - ], + 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100001080'], + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'Enterprise edition cluster test'], ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplateId', - 'errorMessage' => 'Invalid Whitelist templateId.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', - 'errorMessage' => 'No permission to operate the whitelist template.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - ], - 'AttachWhitelistTemplateToInstance' => [ - 'summary' => '白名单模板关联实例。', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100001080,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Enterprise edition cluster test\\"\\n }\\n}","type":"json"}]', + 'title' => '重启集群', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:RestartDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'StartDBInstance' => [ + 'summary' => '调用StartDBInstance接口启动云数据库ClickHouse企业版集群。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeCode' => '189351', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'description' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'TemplateId', + 'name' => 'DBInstanceId', 'in' => 'query', + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '白名单模板Id', - 'description' => '白名单模板Id', - 'type' => 'string', - 'required' => true, - 'example' => '98a6d3db05984dca', + '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'], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000837'], + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'Enterprise edition cluster test'], + ], + ], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000837,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Enterprise edition cluster test\\"\\n }\\n}","type":"json"}]', + 'title' => '启动集群', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:StartDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + ], + 'StopDBInstance' => [ + 'summary' => '调用StopDBInstance接口暂停云数据库ClickHouse企业版集群。', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '189348', + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], [ 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '数据库实例。逗号分隔，一次关联变更不超过20个', - 'description' => '数据库实例。逗号分隔，一次关联变更不超过20个', - 'type' => 'string', - 'required' => true, - 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', - ], + 'schema' => ['description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****'], ], ], 'responses' => [ @@ -7372,308 +6732,115 @@ 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], 'Data' => [ - 'title' => '', - 'description' => '返回数据。', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '操作状态。ok', - 'description' => '操作状态。ok', - 'type' => 'string', - 'example' => 'ok', - ], - 'AttachFailList' => [ - 'title' => '解绑失败实例', - 'description' => '解绑失败实例', - 'type' => 'array', - 'items' => [ - 'title' => '实例解绑失败详情', - 'description' => '实例解绑失败详情', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例名称', - 'description' => '实例名称', - 'type' => 'string', - 'example' => 'my-database', - ], - 'Reason' => [ - 'title' => '解绑失败原因', - 'description' => '解绑失败原因', - 'type' => 'string', - 'example' => '处理异常', - ], - ], - ], - ], - 'AttachSuccessedList' => [ - 'title' => '绑定成功模板', - 'description' => '绑定成功模板', - 'type' => 'array', - 'items' => [ - 'title' => '实例绑定成功详情', - 'description' => '实例绑定成功详情', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例名称', - 'description' => '实例名称', - 'type' => 'string', - 'example' => 'my-database', - ], - 'Templates' => [ - 'title' => '白名单模板列表', - 'description' => '白名单模板列表', - 'type' => 'array', - 'items' => [ - 'title' => '模板详情', - 'description' => '模板详情', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'description' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'TemplateName' => [ - 'title' => '白名单模板名称', - 'description' => '白名单模板名称', - 'type' => 'string', - 'example' => 'demo_template', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'description' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], - 'DbInstances' => [ - 'title' => '关联的实例列表', - 'description' => '关联的实例列表', - 'type' => 'array', - 'items' => [ - 'title' => '实例详情', - 'description' => '实例详情', - 'type' => 'object', - 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例ID', - 'description' => '实例ID', - 'type' => 'string', - 'example' => 'asdfwef', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'TaskId' => ['description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100000785'], + 'DBInstanceID' => ['description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****'], + 'DBInstanceName' => ['description' => '集群名称。', 'type' => 'string', 'example' => 'Enterprise edition cluster test'], ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplateId', - 'errorMessage' => 'Invalid Whitelist templateId.', - ], - [ - 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', - 'errorMessage' => 'No permission to operate the whitelist template.', - ], - [ - 'errorCode' => 'InvalidDBInstanceId.TooManyItems', - 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', - ], - [ - 'errorCode' => 'InvalidParameter.DBInstanceId', - 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', - ], - [ - 'errorCode' => 'InvalidAttachTemplate.QuotaExceeded', - 'errorMessage' => 'Exceed the upper limit of the template that the instance can bind.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"AttachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"AttachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => '白名单模板关联实例', - ], - 'ListWhitelistTemplates' => [ - 'summary' => '查询白名单模板清单', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000785,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"Enterprise edition cluster test\\"\\n }\\n}","type":"json"}]', + 'title' => '暂停集群', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:StopDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], ], + ], + 'UpdateWhitelistTemplate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'TemplateName', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '模板名称，支持模糊查询', - 'type' => 'string', - 'example' => 'default', - ], + 'schema' => ['title' => '白名单模板Id', 'description' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca'], ], [ - 'name' => 'PageNumber', + 'name' => 'TemplateName', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '白名单模板Id', 'description' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca'], ], [ - 'name' => 'PageSize', + 'name' => 'SecurityIPList', 'in' => 'query', - 'schema' => [ - 'title' => '每页记录数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '25', - 'default' => '25', - ], + 'schema' => ['title' => '白名单列表. 逗号分隔，数量不超过100个。', 'description' => '白名单列表. 逗号分隔，数量不超过100个。', 'type' => 'string', 'required' => true, 'example' => '192.168.1.1,10.0.0.1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', + 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Request ID。', 'type' => 'string', 'example' => '1234567890'], 'Data' => [ - 'title' => '白名单模板清单结果', + 'title' => '', + 'description' => '白名单模板详情。', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总数', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'PageSize' => [ - 'title' => '分页数量', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'CurrPageNumbers' => [ - 'title' => '当前页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalPageNumbers' => [ - 'title' => '总页码', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'HasPrev' => [ - 'title' => '是否有前一页', - 'type' => 'boolean', - 'example' => 'false', - ], - 'HasNext' => [ - 'title' => '是否有后一页', - 'type' => 'boolean', - 'example' => 'true', - ], 'Templates' => [ 'title' => '白名单模板列表', + 'description' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', + 'description' => '模板详情。', 'type' => 'object', 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'TemplateName' => [ - 'title' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], + 'TemplateId' => ['title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem'], + 'SecurityIPList' => ['title' => 'ip白名单列表', 'description' => 'IP白名单列表。', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1'], 'DbInstances' => [ 'title' => '关联的实例列表', + 'description' => '关联的实例列表。', 'type' => 'array', 'items' => [ 'title' => '实例详情', + 'description' => '实例详情', 'type' => 'object', 'properties' => [ - 'DBInstanceId' => [ - 'title' => '实例ID', - 'type' => 'string', - 'example' => 'cc-asdfwef', - ], + 'DbInstanceName' => ['title' => '实例ID', 'description' => '实例ID。', 'type' => 'string', 'example' => 'asdfwef'], ], ], ], @@ -7688,238 +6855,854 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], + ['errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'Specified IPList is not valid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', 'description' => ''], + ['errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', 'description' => ''], + ['errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], - ], - 'ListInstanceLinkedWhitelistTemplates' => [ - 'summary' => '查询实例关联的白名单模板清单', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'title' => '更新白名单模板', + 'summary' => '更新白名单模板。', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:UpdateWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DbInstanceName\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpgradeMinorVersion' => [ + 'summary' => '调用UpgradeMinorVersion接口升级指定云数据库ClickHouse企业版集群的内核小版本。', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '185639', - 'abilityTreeNodes' => [ - 'FEATUREclickhouseCVENTL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '196979', + 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'DBInstanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'RegionId', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '实例ID', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1jyis8p15we****'], ], [ - 'name' => 'DBInstanceId', + 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => [ - 'title' => '实例名称', + 'title' => '切换模式', + 'description' => '是否立即升级，取值说明：'."\n" + .'- **Immediate**：立即升级。'."\n" + .'- **MaintainTime**：在可运维时间段内升级。'."\n" + .'- **SpecifyTime**：指定时间升级。', 'type' => 'string', - 'required' => true, - 'example' => 'cc-exadfas', + 'required' => false, + 'example' => 'Immediate', + 'default' => 'Immediate', + 'enum' => ['Immediate', 'MaintainTime', 'SpecifyTime'], ], ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => ['title' => '指定时间点切换时，指定切换时间点。', 'description' => '指定的升级时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" + .'> 当SwitchTimeMode为SpecifyTime时，需要通过该参数指定升级时间。', 'type' => 'string', 'required' => false, 'example' => '2023-01-09T05:00:00Z'], + ], + [ + 'name' => 'TargetMinorVersion', + 'in' => 'query', + 'schema' => ['title' => '目标内核小版本，默认升级到最新。', 'description' => '目标内核小版本。'."\n" + .'>默认不填写，直接升级到最新的内核小版本。', 'type' => 'string', 'required' => false, 'example' => '23.8.1.41495_6'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - 'example' => '1234567890', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7'], 'Data' => [ - 'title' => '白名单模板清单结果', + 'description' => '返回结果。', 'type' => 'object', 'properties' => [ - 'Templates' => [ - 'title' => '白名单模板列表', - 'type' => 'array', - 'items' => [ - 'title' => '模板详情', - 'type' => 'object', - 'properties' => [ - 'TemplateId' => [ - 'title' => '白名单模板ID', - 'type' => 'string', - 'example' => 'g-asdfwem', - ], - 'TemplateName' => [ - 'title' => '白名单模板名称', - 'type' => 'string', - 'example' => 'demo_template', - ], - 'SecurityIPList' => [ - 'title' => 'ip白名单列表', - 'type' => 'string', - 'example' => '192.168.1.1,10.0.0.1', - ], - ], - ], - ], + 'DBInstanceName' => ['description' => '实例ID。', 'type' => 'string', 'example' => 'cc-uf6x229yeq166****'], ], ], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'Invalid parameter.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], + 'title' => '升级内核小版本', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:UpgradeMinorVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"cc-uf6x229yeq166****\\"\\n }\\n}","type":"json"}]', ], ], 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'clickhouse.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'clickhouse.aliyuncs.com', + ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => '华北6（乌兰察布）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-qingdao.aliyuncs.com', 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-hongkong.aliyuncs.com', 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-northeast-1.aliyuncs.com', 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-chengdu.aliyuncs.com', 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => '华南3（广州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-southeast-1.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-southeast-5.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => '菲律宾（马尼拉）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.ap-southeast-6.aliyuncs.com', 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', 'vpc' => 'clickhouse-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.us-east-1.aliyuncs.com', 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.eu-west-1.aliyuncs.com', 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.us-west-1.aliyuncs.com', 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'clickhouse.eu-central-1.aliyuncs.com', 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => '沙特（利雅得）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'clickhouse.me-central-1.aliyuncs.com', 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'Account is not found.', 'http_code' => 404, 'description' => '未找到对应账号。'], + ['code' => 'ACTION_UNAUTHORIZED', 'message' => 'The account balance is insufficient, and the opening of the public network needs to rely on load balancing service, which requires that the account balance must be greater than 100 yuan.', 'http_code' => 403, 'description' => '账户余额不足，开通公网需要依赖负载均衡服务，要求账户余额必须大于100元人民币'], + ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Invalid component for commodity.', 'http_code' => 500, 'description' => '订单配置参数不符合校验条件，请重新选配商品。'], + ['code' => 'DescribeLorneLogException', 'message' => 'Cannot find taskDetail in Lorne.', 'http_code' => 500, 'description' => '未找到对应SLS的任务详情。'], + ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => '账户未被授予操作资源的权限'], + ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => '资源不足。'], + ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => '系统内部错误，请稍后重试'], + ['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => '该请求出现系统内部错误。'], + ['code' => 'InvalidAccountName.NotFound', 'message' => 'Specified account name does not exist.', 'http_code' => 404, 'description' => '指定的账号名称不存在。'], + ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter "BackupRetentionPeriod" is not valid.', 'http_code' => 400, 'description' => '请求参数 “BackupRetentionPeriod” 不合法。'], + ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '您指定的 DBClusterId 不存在，请确认 DBClusterId 值是否正确。'], + ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '传入的实例ID不存在。'], + ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => '传入的实例ID不存在。'], + ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => '未找到有效实例'], + ['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter "PageNumber" is not valid.', 'http_code' => 400, 'description' => '指定的参数“ PageNumber”无效。'], + ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter "PageSize" is not valid.', 'http_code' => 400, 'description' => '指定的参数“ PageSize”无效。'], + ['code' => 'InvalidParameter.DBClusterVersion', 'message' => 'The version is invalid. Check whether the DBClusterVersion, MinorVersion, and MajorVersion parameters are correct.', 'http_code' => 400, 'description' => '版本参数不合法，请检查DBClusterVersion、MinorVersion、MajorVersion参数是否正确'], + ['code' => 'InvalidParameter.DBNodeStorage', 'message' => 'The specified parameter "DBNodeStorage" is not valid.', 'http_code' => 400, 'description' => '指定的参数"DBNodeStorage"无效。'], + ['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter "RegionId" is not valid.', 'http_code' => 400, 'description' => '指定的参数“ RegionId”无效。'], + ['code' => 'InvalidSecurityIPs.Exceeded', 'message' => 'The specified parameter "SecurityIps" count is exceeded 200.', 'http_code' => 400, 'description' => '安全组IP数总量超过200。'], + ['code' => 'InvalidVPC.NotFound', 'message' => 'VPC or VSwitch is not valid.', 'http_code' => 404, 'description' => '传入的VPC ID不存在。'], + ['code' => 'InvalidVpcId.Malformed', 'message' => 'The specified parameter "VpcId" is not valid.', 'http_code' => 400, 'description' => '参数"VpcId"无效'], + ['code' => 'ModifyServerConfigFailed', 'message' => 'Failed to modify server config.', 'http_code' => 500, 'description' => '修改实例配置失败。'], + ['code' => 'OperationDenied.CKNotConnected', 'message' => 'Connect to ClickHouse Cluster Failed.', 'http_code' => 403, 'description' => '连接CK失败，请检查CK状态、白名单及连通性。'], + ['code' => 'OperationDenied.VirtualWarehouseShardsAlign', 'message' => 'The operation is not permitted due to virtualWarehouse shards align.', 'http_code' => 403, 'description' => '由于实例分片对齐，不允许该操作。'], + ['code' => 'PRICE.PRICING_PLAN_RESULT_NOT_FOUND', 'message' => 'Cannot find pricing plan for the commodity.', 'http_code' => 500, 'description' => '定价计划价格结果没有找到。'], + ['code' => 'ServiceUnavailable', 'message' => 'An error occurred while processing your request.', 'http_code' => 503, 'description' => '系统暂时不可用，请稍后重试'], + ['code' => 'UNAVAILABLE', 'message' => 'Service Unavailable.', 'http_code' => 502, 'description' => '服务不可用。'], + ['code' => 'UNKNOWN', 'message' => 'Unknown error.', 'http_code' => 500, 'description' => '未知错误。'], + ['code' => 'UserNotInBuyWhiteList', 'message' => 'ClickHouse is at the canary release stage. Please apply for use by submitting a ticket.', 'http_code' => 500, 'description' => 'ClickHouse 目前在灰度阶段，请提工单申请'], + ['code' => 'InvalidSpecification', 'message' => 'Specification parameter is not valid.', 'http_code' => 400, 'description' => '规格参数无效。'], + ['code' => 'InvalidDBInstanceStatus', 'message' => 'The specified instance state does\'t support this operation.', 'http_code' => 400, 'description' => '实例状态不允许当前操作。'], + ['code' => 'OperationDenied.OrderProcessing', 'message' => 'The operation is not permitted due to there is an order in processing of cluster.', 'http_code' => 400, 'description' => '存在未完成的订单，请稍后再试。'], + ['code' => 'OperationDenied.NothingChanged', 'message' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.', 'http_code' => 400, 'description' => '实例操作变更配置，但传入配置与当前配置相同，没有任何改变。'], + ['code' => 'StorageTypeDoNotSupportBackup', 'message' => 'Current StorageType Does Not Support Backup.', 'http_code' => 400, 'description' => '当前存储类型不支持备份'], + ], + 'changeSet' => [], + 'ram' => [ + 'productCode' => 'ClickHouse', + 'productName' => '云数据库 ClickHouse ', + 'ramCodes' => ['clickhouse'], + 'ramLevel' => '资源级', + 'ramConditions' => [ + [ + 'name' => 'clickhouse:EncryptionType', + 'schema' => ['type' => 'Array<String>', 'description' => '加密类型'], + ], ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', + 'ramActions' => [ + [ + 'apiName' => 'DescribeDBInstanceAttribute', + 'description' => '查询集群的详细信息', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceConfigChangeLog', + 'description' => '查询实例参数变更记录', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceConfigChangeLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'StopDBInstance', + 'description' => '暂停集群', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:StopDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteWhitelistTemplate', + 'description' => '删除白名单模板', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceConnectionString', + 'description' => '修改连接地址', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceConnectionString', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceDataSources', + 'description' => '查询DB或者Table的数据结构', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateDB', + 'description' => '创建数据库', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateDB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifySecurityIPList', + 'description' => '变更白名单', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifySecurityIPList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyAccountAuthority', + 'description' => '修改账号的授权信息', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeAccountAuthority', + 'description' => '查看账号权限', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccountAuthority', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '修改ClickHouse企业版实例所在资源组', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ChangeResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpgradeMinorVersion', + 'description' => '升级内核小版本', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:UpgradeMinorVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListInstanceLinkedWhitelistTemplates', + 'description' => '查询实例关联的白名单模板', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:ListInstanceLinkedWhitelistTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListClickHouseDBTimezones', + 'description' => '获取ClickHouse时区枚举值列表', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:ListClickHouseDBTimezones', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeSlowLogTrend', + 'description' => '查询慢日志趋势', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogTrend', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyBackupPolicy', + 'description' => '修改备份策略', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteEndpoint', + 'description' => '释放外网地址', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteEndpoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DetachWhitelistTemplateToInstance', + 'description' => '取消白名单模板和实例关联关系', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:DetachWhitelistTemplateToInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeAccounts', + 'description' => '查询账号列表', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeAccounts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteBackupPolicy', + 'description' => '删除备份策略', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ResetAccountPassword', + 'description' => '重置账号的密码', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ResetAccountPassword', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'KillProcess', + 'description' => '终止正在进行的任务', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:KillProcess', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceClass', + 'description' => '修改集群弹性配置', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceClass', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateDBInstance', + 'description' => '创建集群', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDB', + 'description' => '删除数据库', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteDB', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ListWhitelistTemplates', + 'description' => '查询实例关联的白名单模板', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:ListWhitelistTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateEndpoint', + 'description' => '申请外网地址', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateEndpoint', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeBackups', + 'description' => '查看备份集', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'RestartDBInstance', + 'description' => '重启集群', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:RestartDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstances', + 'description' => '查询集群列表', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'StartDBInstance', + 'description' => '启动集群', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:StartDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeSlowLogRecords', + 'description' => '查询慢日志明细', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSlowLogRecords', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateBackupPolicy', + 'description' => '创建备份策略', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:CreateBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeEndpoints', + 'description' => '查询集群访问地址', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeEndpoints', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeRegions', + 'description' => '获取ClickHouse企业版可用地域', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeRegions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeBackupPolicy', + 'description' => '查看备份策略', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeBackupPolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateWhitelistTemplate', + 'description' => '创建白名单模板', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyAccountDescription', + 'description' => '修改账号备注', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyAccountDescription', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeProcessList', + 'description' => '查看正在运行中的查询', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeProcessList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeSecurityIPList', + 'description' => '查询白名单', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeSecurityIPList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'GetWhitelistTemplate', + 'description' => '查询白名单模板详情', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:GetWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceAttribute', + 'description' => '修改集群的配置属性', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DescribeDBInstanceConfig', + 'description' => '查询实例参数配置', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'clickhouse:DescribeDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'ModifyDBInstanceConfig', + 'description' => '修改实例配置', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'clickhouse:ModifyDBInstanceConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'CreateAccount', + 'description' => '创建账号', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'clickhouse:CreateAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'AttachWhitelistTemplateToInstance', + 'description' => '白名单模板关联实例', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:AttachWhitelistTemplateToInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAccount', + 'description' => '删除账号', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteAccount', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'DeleteDBInstance', + 'description' => '释放集群', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'clickhouse:DeleteDBInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], + ], + ], + ], + [ + 'apiName' => 'UpdateWhitelistTemplate', + 'description' => '更新白名单模板', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'clickhouse:UpdateWhitelistTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => '全部资源', 'arn' => '*'], + ], + ], + ], ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'clickhouse.aliyuncs.com', + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'EnterpriseDBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:enterprisedbcluster/{#DBInstanceId}'], ], ], ]; |