'1.0', 'info' => ['style' => 'RPC', 'product' => 'clickhouse', 'version' => '2019-11-11'], 'directories' => [ [ 'children' => ['CreatePortsForClickHouse', 'ReleaseClusterPublicConnection', 'AllocateClusterPublicConnection', 'DescribeDBClusterNetInfoItems'], 'type' => 'directory', 'title' => 'Network management', ], [ 'children' => ['CreateSQLAccount', 'CreateAccountAndAuthority', 'DescribeAccountAuthority', 'ModifyAccountAuthority'], 'type' => 'directory', 'title' => 'Account management', ], [ 'children' => ['CreateMonitorDataReport', 'CheckMonitorAlert'], 'type' => 'directory', 'title' => 'Security management', ], [ 'children' => [ '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', ], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AllocateClusterPublicConnection' => [ 'summary' => 'Allocates a public endpoint for a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19418', 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => ['description' => 'The prefix of the public endpoint. The value is the cluster ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'AllocateClusterPublicConnection', '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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', ], 'CancelActiveOperationTasks' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '201219', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => 'The O\\&M task IDs. Separate multiple IDs with a comma (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '188****,188****,188****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Ids' => ['description' => 'The IDs of the O\\&M tasks that were canceled. Multiple IDs are separated by a comma (,).', 'type' => 'string', 'example' => '188****,188****,188****'."\n", 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CancelActiveOperationTasks', 'summary' => 'Cancels tasks for O&M events.', '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' => 'Cancels a scheduled ZooKeeper leader switchover on a community-compatible ClickHouse instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '173004', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- 30 (default)'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0'], ], 'title' => '', 'description' => 'Schema of response.', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CancelAppointmentElectZookeeperLeader', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","type":"json"}]', ], 'CancelAppointmentRestartInstanceNodeList' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '173004', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- 30 (default)'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0'], ], 'title' => '', 'description' => 'Schema of response.', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CancelAppointmentRestartInstanceNodeList', 'summary' => 'Cancels the scheduled restart on the specified ClickHouse nodes.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","type":"json"}]', ], 'CancelRestartInstance' => [ 'summary' => 'Cancels a scheduled restart for a specific community-compatible ApsaraDB for ClickHouse cluster.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '173004', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in a specific region. The information includes the cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1t9lbb7a4z7****'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- 30 (default)'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'RestartTime', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The scheduled restart time. The time must be in the \\`yyyy-MM-ddTHH:mmZ\\` format and in UTC.', 'title' => '', 'example' => '2023-03-22T00:00:50Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F34'], ], 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CancelRestartInstance', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F34\\"\\n}","type":"json"}]', ], 'ChangeResourceGroup' => [ 'summary' => 'Changes the resource group of a community-edition compatible ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '163948', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The resource ID.', 'example' => 'cc-bp1i43033051****'], ], [ 'name' => 'ResourceRegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The region ID.', 'example' => 'cn-hangzhou'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => 'The ID of the destination resource group.', 'example' => 'rg-4690g37929****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => 'The request ID.', 'example' => 'C342F3DD-1FF7-55E9-A1A1-098DE07CD1A2'], ], 'title' => '', 'description' => 'The data returned.', 'example' => '', ], ], ], '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' => 'ChangeResourceGroup', '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' => 'Call the CheckClickhouseToRDS operation to verify the connectivity between a community-compatible ApsaraDB for ClickHouse cluster and an ApsaraDB RDS for MySQL instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '43669', 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ 'name' => 'DbClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the community-compatible ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-2zeyy362b5sbm****'], ], [ 'name' => 'ClickhousePort', 'in' => 'query', 'schema' => ['description' => 'The port number of the ApsaraDB for ClickHouse cluster.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '8123'], ], [ 'name' => 'CkUserName', 'in' => 'query', 'schema' => ['description' => 'The database account for the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user1'], ], [ 'name' => 'CkPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the ApsaraDB for ClickHouse database account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Aa'], ], [ 'name' => 'RdsId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraDB RDS instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rm-bp13v4bnwlu8j****'], ], [ 'name' => 'RdsPort', 'in' => 'query', 'schema' => ['description' => 'The port number of the ApsaraDB RDS instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3306'], ], [ 'name' => 'RdsVpcId', 'in' => 'query', 'schema' => ['description' => 'The VPC ID of the ApsaraDB RDS instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'vpc-wz9mm0qka0winfl47****'], ], [ 'name' => 'RdsUserName', 'in' => 'query', 'schema' => ['description' => 'The database account for the ApsaraDB RDS instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user2'], ], [ 'name' => 'RdsPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the ApsaraDB RDS database account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Rr'], ], [ 'name' => 'RdsVpcUrl', 'in' => 'query', 'schema' => ['description' => 'The internal endpoint of the ApsaraDB RDS instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'A82758F8-E793-5610-BE11-0E46664305C2'], 'Status' => ['description' => 'Indicates whether a connection can be established. Valid values:'."\n" ."\n" .'- **true**: A connection can be established.'."\n" ."\n" .'- **false**: A connection cannot be established.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'ErrorCode' => ['description' => '- This parameter is returned only if the connection fails (**Status** is **false**).'."\n" ."\n" .'- It indicates the reason for the connection failure.', 'type' => 'string', 'title' => '', 'example' => 'NotSameVpc'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CheckClickhouseToRDS', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckClickhouseToRDS'], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A82758F8-E793-5610-BE11-0E46664305C2\\",\\n \\"Status\\": false,\\n \\"ErrorCode\\": \\"NotSameVpc\\"\\n}","type":"json"}]', ], 'CheckModifyConfigNeedRestart' => [ 'summary' => 'Calls the CheckModifyConfigNeedRestart operation to check whether modifying configuration parameters in XML mode requires a restart for an ApsaraDB for ClickHouse Community-compatible Edition cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '152285', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in the specified region, including cluster IDs.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1tm8zf130ew****', 'title' => ''], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The configuration parameters to be modified.', 'type' => 'string', 'required' => true, 'example' => ''."\n" .''."\n" .' 400'."\n" .' 4096'."\n" .' '."\n" .' debug'."\n" .' 1000M'."\n" .' '."\n" .' 5368709120'."\n" .' 201'."\n" .' 4096'."\n" .' 0'."\n" .' 0'."\n" .' '."\n" .' 256'."\n" .' auto'."\n" .' 100'."\n" .' 1'."\n" .' '."\n" .' 1717986918'."\n" .'', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'NeedRestart' => ['description' => 'Indicates whether a restart is required after the configuration parameters are modified. Valid values:'."\n" .'- **true**: A restart is required.'."\n" .'- **false**: A restart is not required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C', 'title' => ''], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'Check whether modifying configuration parameters requires a restart', 'description' => '>This operation supports only Community-compatible Edition clusters created after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:CheckModifyConfigNeedRestart', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"NeedRestart\\": true,\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\"\\n}","type":"json"}]', ], 'CheckMonitorAlert' => [ 'summary' => 'Call the CheckMonitorAlert operation to check whether the alert monitoring feature of Application Real-Time Monitoring Service (ARMS) is enabled for a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '81031', 'abilityTreeNodes' => ['FEATUREclickhouse1YZKWF'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp13s14l8498l****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD'], 'State' => ['description' => 'Indicates whether the alert monitoring feature is enabled. Valid values:'."\n" ."\n" .'- **enable**: The feature is enabled.'."\n" ."\n" .'- **disable**: The feature is disabled.', 'type' => 'string', 'title' => '', 'example' => 'enable'], 'Parameter' => ['description' => 'The parameters for alert monitoring.', 'type' => 'string', 'title' => '', 'example' => '{ "monitor":{ "key1":"value1", "key2":"value2" }, "alert":{ "key1":"value1", "key2":"value2" } }'], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"State\\": \\"enable\\",\\n \\"Parameter\\": \\"{ \\\\\\"monitor\\\\\\":{ \\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\" }, \\\\\\"alert\\\\\\":{ \\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\":\\\\\\"value2\\\\\\" } }\\"\\n}","type":"json"}]', 'title' => 'CheckMonitorAlert', 'description' => '> This operation applies only to community-compatible clusters of version 20.8 or later that were created after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CheckMonitorAlert'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:CheckMonitorAlert', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], ], ], 'CheckScaleOutBalanced' => [ 'summary' => 'Performs a migration scale-out check on a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '19419', 'abilityTreeNodes' => ['FEATUREclickhouse07PB80'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" .'- **30** (default)'."\n" .'- **50**'."\n" .'- **100**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ScalingType', 'in' => 'query', 'schema' => ['description' => 'The specification change type. Valid values:'."\n" .'- ScaleOut: horizontal scale-out'."\n" .'- ScaleIn: horizontal scale-in'."\n" .'- MultiAzUpgrade: upgrade to multi-active zone deployment'."\n" .'- DiskDownGrade: cloud disk downgrade.', 'type' => 'string', 'required' => false, 'example' => 'ScaleOut', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'TableDetails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'TableDetail' => [ 'description' => 'The check failure information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TableName' => ['description' => 'The local table name.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'Cluster' => ['description' => 'The cluster. The value is fixed as **default**.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'Database' => ['description' => 'The database name.', 'type' => 'string', 'example' => 'db_name', 'title' => ''], 'Detail' => ['description' => 'The exception details. Valid values:'."\n" ."\n" .'- **1**: The unique distributed table is missing.'."\n" .'- **2**: The corresponding distributed table is not unique.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" .'- **30** (default)'."\n" .'- **50**'."\n" .'- **100**.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CheckCode' => ['description' => 'The check result. Valid values:'."\n" .'- **400**: The check failed.'."\n" .'- **200**: The check succeeded.', 'type' => 'string', 'example' => '400', 'title' => ''], 'TimeDuration' => ['description' => 'The time required for the migration scale-out. Unit: minutes.', 'type' => 'string', 'example' => '21', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'Scale-out check', '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19420', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'list', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n"], 'HasServiceLinkedRole' => ['description' => 'Indicates whether the service-linked role exists.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CheckServiceLinkedRole', 'summary' => 'Queries the service-linked role for ApsaraDB for ClickHouse.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:CheckServiceLinkedRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"HasServiceLinkedRole\\": true\\n}","type":"json"}]', ], 'CreateAccount' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '19421', 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the database account.'."\n" ."\n" .'> '."\n" ."\n" .'* The name must be unique in the cluster.'."\n" ."\n" .'* The name can contain lowercase letters, digits, and underscores (\\_).'."\n" .'* The name must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" .'* The name must be 2 to 64 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The password of the database account.'."\n" ."\n" .'> '."\n" ."\n" .'* The password must contain at least three types of the following characters: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'* The password can contain the following special characters: ! @ # $ % ^ & \\* ( ) \\_ + - ='."\n" .'* The password must be 8 to 32 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123789Ff!', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the database account.'."\n" ."\n" .'> '."\n" ."\n" .'* The description cannot start with http:// or https://.'."\n" ."\n" .'* The description must be 0 to 256 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ceshi', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateAccount', 'summary' => 'Creates a database account for an ApsaraDB for ClickHouse cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 2FED790E-FB61-4721-8C1C-07C627FA5A19\\n","errorExample":""}]', ], 'CreateAccountAndAuthority' => [ 'summary' => 'Creates a database account and grants permissions.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '19422', 'abilityTreeNodes' => ['FEATUREclickhouseL1079N', 'FEATUREclickhouse2H8YOY'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1p816075e21****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the database account.'."\n" ."\n" .'- Must be unique within the cluster.'."\n" ."\n" .'- Can contain only lowercase letters, digits, and underscores (\\_).'."\n" ."\n" .'- Must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" ."\n" .'- Must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the database account.'."\n" ."\n" .'> - Must contain characters from at least three of the following types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- The supported special characters are `!@#$%^&*()_+-=`.'."\n" ."\n" .'- Must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456Aa', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the database account.'."\n" ."\n" .'- Cannot start with `http://` or `https://`.'."\n" ."\n" .'- Must be 0 to 256 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ceshi', 'title' => ''], ], [ 'name' => 'DmlAuthority', 'in' => 'query', 'schema' => ['description' => 'Specifies the DML permissions for the database account. Valid values:'."\n" ."\n" .'- **all**: read, write, and settings permissions.'."\n" ."\n" .'- **readOnly,modify**: read and settings permissions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all', 'title' => ''], ], [ 'name' => 'DdlAuthority', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to grant DDL permissions to the database account. Valid values:'."\n" ."\n" .'- **true**: DDL operations are allowed.'."\n" ."\n" .'- **false**: DDL operations are denied.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AllowDatabases', 'in' => 'query', 'schema' => ['description' => 'The databases to which the account has permissions. Separate multiple database names with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'db1', 'title' => ''], ], [ 'name' => 'TotalDatabases', 'in' => 'query', 'schema' => ['description' => 'All databases in the cluster. Separate multiple database names with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'db1,db2', 'title' => ''], ], [ 'name' => 'AllowDictionaries', 'in' => 'query', 'schema' => ['description' => 'The dictionaries to which the account has permissions. Separate multiple dictionary names with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dt1', 'title' => ''], ], [ 'name' => 'TotalDictionaries', 'in' => 'query', 'schema' => ['description' => 'All dictionaries in the cluster. Separate multiple dictionary names with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dt1,dt2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', 'title' => 'CreateAccountAndAuthority', 'description' => 'This API is available only for cluster versions 21.8 and earlier. For newer versions, use a high-privilege account and SQL statements to modify user permissions.', '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}'], ], ], ], ], ], 'CreateBackupPolicy' => [ 'summary' => 'Creates a backup policy.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '19423', 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => ['description' => 'The backup time in UTC. The format is HH:mmZ-HH:mmZ.'."\n" ."\n" .'Example: 00:00Z-01:00Z. This means that data backup can be performed from 00:00 to 01:00 UTC (08:00 to 09:00 UTC+8).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '10:00Z-11:00Z'], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => ['description' => 'The backup cycle. If you specify multiple days, separate them with commas. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'Monday,Friday'], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The backup retention period in days. The value must be an integer from 7 to 730. The default value is 7.', 'type' => 'string', 'required' => false, 'default' => '7', 'title' => '', 'example' => '8'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateBackupPolicy', 'description' => '> ApsaraDB for ClickHouse supports data backup for clusters that run version 20.3, 20.8, or 21.8.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateBackupPolicy'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', ], 'CreateDBInstance' => [ 'summary' => 'Create an Alibaba Cloud ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '19424', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) API to query the latest region list.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => ['description' => 'The availability zone ID. You can call the [DescribeRegions](~~170875~~) API to query the latest availability zone list.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', 'title' => ''], ], [ 'name' => 'DBClusterVersion', 'in' => 'query', 'schema' => [ 'description' => 'The engine version. Valid values:'."\n" ."\n" .'- **21.8.10.19**'."\n" ."\n" .'- **22.8.5.29**', 'enumValueTitles' => ['22.8.5.29' => '22.8.5.29', '21.8.10.19' => '21.8.10.19'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '22.8.5.29', 'title' => '', ], ], [ 'name' => 'DBClusterCategory', 'in' => 'query', 'schema' => [ 'description' => 'The replica configuration. Valid values:'."\n" ."\n" .'- **Basic**: single-replica'."\n" ."\n" .'- **HighAvailability**: high availability (dual-replica)', 'enumValueTitles' => ['Basic' => 'Basic', 'HighAvailability' => 'HighAvailability'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Basic', 'title' => '', ], ], [ 'name' => 'DBClusterClass', 'in' => 'query', 'schema' => ['description' => 'The instance type.'."\n" ."\n" .'- For single-replica clusters, valid values are:'."\n" ."\n" .' - **LS20**: Large-storage, 20 cores, 88 GB'."\n" ."\n" .' - **LS40**: Large-storage, 40 cores, 176 GB'."\n" ."\n" .' - **LS80**: Large-storage, 80 cores, 352 GB'."\n" ."\n" .' - **S8**: Standard, 8 cores, 32 GB'."\n" ."\n" .' - **S16**: Standard, 16 cores, 64 GB'."\n" ."\n" .' - **S32**: Standard, 32 cores, 128 GB'."\n" ."\n" .' - **S64**: Standard, 64 cores, 256 GB'."\n" ."\n" .' - **S80**: Standard, 80 cores, 384 GB'."\n" ."\n" .' - **S104**: Standard, 104 cores, 384 GB'."\n" ."\n" .'- For high availability clusters, valid values are:'."\n" ."\n" .' - **LC20**: Large-storage, 20 cores, 88 GB'."\n" ."\n" .' - **LC40**: Large-storage, 40 cores, 176 GB'."\n" ."\n" .' - **LC80**: Large-storage, 80 cores, 352 GB'."\n" ."\n" .' - **C8**: Standard, 8 cores, 32 GB'."\n" ."\n" .' - **C16**: Standard, 16 cores, 64 GB'."\n" ."\n" .' - **C32**: Standard, 32 cores, 128 GB'."\n" ."\n" .' - **C64**: Standard, 64 cores, 256 GB'."\n" ."\n" .' - **C80**: Standard, 80 cores, 384 GB'."\n" ."\n" .' - **C104**: Standard, 104 cores, 384 GB'."\n" ."\n" .''."\n" ."\n" .'- For single-replica clusters, valid values are:'."\n" ."\n" .' - **S8**: 8 cores, 32 GB'."\n" ."\n" .' - **S16**: 16 cores, 64 GB'."\n" ."\n" .' - **S32**: 32 cores, 128 GB'."\n" ."\n" .' - **S64**: 64 cores, 256 GB'."\n" ."\n" .' - **S104**: 104 cores, 384 GB'."\n" ."\n" .'- For high availability clusters, valid values are:'."\n" ."\n" .' - **C8**: 8 cores, 32 GB'."\n" ."\n" .' - **C16**: 16 cores, 64 GB'."\n" ."\n" .' - **C32**: 32 cores, 128 GB'."\n" ."\n" .' - **C64**: 64 cores, 256 GB'."\n" ."\n" .' - **C104**: 104 cores, 384 GB'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'S8', 'title' => ''], ], [ 'name' => 'DBNodeGroupCount', 'in' => 'query', 'schema' => ['description' => 'The number of nodes.'."\n" ."\n" .'- For single-replica clusters, the valid range is 1–48.'."\n" ."\n" .'- For high availability clusters, the valid range is 1–24.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'DBNodeStorage', 'in' => 'query', 'schema' => ['description' => 'The storage capacity per node, in GB. The valid range is 100–32,000.'."\n" ."\n" .'> The value must be a multiple of 100.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100', 'title' => ''], ], [ 'name' => 'DBClusterNetworkType', 'in' => 'query', 'schema' => ['description' => 'The network type. Currently, only VPC is supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'VPC', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PayType', 'in' => 'query', 'schema' => [ 'description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go'."\n" ."\n" .'- **Prepaid**: subscription', 'enumValueTitles' => ['Prepaid' => 'Prepaid', 'Postpaid' => 'Postpaid'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prepaid', 'title' => '', ], ], [ 'name' => 'Period', 'in' => 'query', 'schema' => ['description' => 'The subscription duration unit.'."\n" .'>This parameter is required only when `PayType` is set to `Prepaid`.>'."\n" ."\n" .'- **Year**: Measured in years.'."\n" ."\n" .'- **Month**: Measured in months.', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], ], [ 'name' => 'UsedTime', 'in' => 'query', 'schema' => ['description' => 'The subscription duration.'."\n" .'>This parameter is required only when `PayType` is set to `Prepaid`.>'."\n" ."\n" .'- If `Period` is `Year`, the valid range is 1–3.'."\n" ."\n" .'- If `Period` is `Month`, the valid range is 1–9.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'VPCId', 'in' => 'query', 'schema' => ['description' => 'The VPC ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''], ], [ 'name' => 'VSwitchId', 'in' => 'query', 'schema' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1gzt31twhlo0sa5****', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'query', 'schema' => ['description' => 'A client token used to ensure request idempotence. The value must be a string of no more than 64 ASCII characters.', 'type' => 'string', 'required' => false, 'example' => 'AB', 'title' => ''], ], [ 'name' => 'DbNodeStorageType', 'in' => 'query', 'schema' => ['description' => 'The storage type. Valid values:'."\n" ."\n" .''."\n" ."\n" .'- **CloudESSD\\_PL0**: ESSD PL0 cloud disk'."\n" ."\n" .''."\n" ."\n\n" .'- **CloudESSD**: ESSD PL1 cloud disk'."\n" ."\n" .'- **CloudESSD\\_PL2**: ESSD PL2 cloud disk'."\n" ."\n" .'- **CloudESSD\\_PL3**: ESSD PL3 cloud disk'."\n" ."\n" .'- **CloudEfficiency**: Ultra Disk', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'CloudESSD_PL2', 'title' => ''], ], [ 'name' => 'EncryptionKey', 'in' => 'query', 'schema' => ['description' => 'This parameter is required when `EncryptionType` is set to `CloudDisk`.'."\n" ."\n" .'The ID of the cloud disk encryption key. You can create and manage keys in the Key Management Service console.'."\n" ."\n" .'> If `EncryptionType` is not specified, you do not need to specify this parameter.', 'type' => 'string', 'required' => false, 'example' => '0d2470df-da7b-4786-b981-9a164dae****', 'title' => ''], ], [ 'name' => 'EncryptionType', 'in' => 'query', 'schema' => ['description' => 'The encryption type. Only cloud disk encryption is supported. Set this value to **CloudDisk**.'."\n" ."\n" .'> If you do not specify this parameter, encryption is disabled.', 'type' => 'string', 'required' => false, 'example' => 'CloudDisk', 'title' => ''], ], [ 'name' => 'BackupSetID', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup set. You can call the [DescribeBackups](~~360339~~) API to query backup set IDs.'."\n" ."\n" .'> This parameter is required when restoring data to an ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => false, 'example' => 'b-12af23adsf', 'title' => ''], ], [ 'name' => 'SourceDBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source cluster. You can call the [DescribeDBClusters](~~170879~~) API to query cluster IDs.'."\n" ."\n" .'> This parameter is required when restoring data to an ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp1lxbo89u950****', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group that contains the cluster.', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''], ], [ 'name' => 'ZoneIdBak', 'in' => 'query', 'schema' => ['description' => 'The ID of the secondary availability zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-k', 'title' => ''], ], [ 'name' => 'VSwitchBak', 'in' => 'query', 'schema' => ['description' => 'The ID of the secondary VSwitch.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vsw-bp1gzt31twhlo0sa5****'], ], [ 'name' => 'ZondIdBak2', 'in' => 'query', 'schema' => ['description' => 'The ID of the second standby availability zone.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-j', 'title' => ''], ], [ 'name' => 'VSwitchBak2', 'in' => 'query', 'schema' => ['description' => 'The ID of the second standby VSwitch.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'vsw-bp1gzt31twhlo0sa5****'], ], [ 'name' => 'AutoRenew', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable auto-renewal.'."\n" ."\n" .'> This parameter applies only when `PayType` is set to `Prepaid`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'user123', 'title' => '', 'required' => false], 'value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'Example string', 'title' => '', 'required' => false], ], 'title' => '', 'description' => 'A tag.', 'required' => false, 'example' => '', ], 'maxItems' => 20, 'minItems' => 0, 'title' => '', 'description' => 'The tags to add to the cluster.', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''], 'DBClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'cc-bp1qx68m06981****', 'title' => ''], 'OrderId' => ['description' => 'The ID of the order.', 'type' => 'string', 'example' => '21137950671****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"DBClusterId\\": \\"cc-bp1qx68m06981****\\",\\n \\"OrderId\\": \\"21137950671****\\"\\n}","type":"json"}]', 'title' => 'CreateDBInstance', 'description' => 'Before you call this API, make sure that you understand the billing method and [price](~~167450~~) of ApsaraDB for ClickHouse.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateDBInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateMonitorDataReport' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '81430', 'abilityTreeNodes' => ['FEATUREclickhouse1YZKWF'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp13s14l8498l****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region. Call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD'], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateMonitorDataReport', 'summary' => 'Creates a monitoring data report.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateMonitorDataReport'], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\"\\n}","type":"json"}]', ], 'CreateOSSStorage' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '19425', 'abilityTreeNodes' => ['FEATUREclickhouseOCIS36'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1z3a2hc8dmt****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1F488A93-83FD-540F-9B67-0333AF64E6A0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateOSSStorage', 'summary' => 'Creates a cold storage space.', 'description' => 'The tiered storage of hot and cold data feature is supported only by community-compatible clusters that run version 20.8 or later. For clusters that run an earlier version, you must migrate data to a cluster that runs version 20.8 or later before you can configure tiered storage. For more information about data migration, see [Data migration between ApsaraDB for ClickHouse instances](~~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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F488A93-83FD-540F-9B67-0333AF64E6A0\\"\\n}","type":"json"}]', ], 'CreatePortsForClickHouse' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '25552', 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'PortType', 'in' => 'query', 'schema' => ['description' => 'The port type. The value must be \\`mysql\\_port\\`.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mysql_port'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query the available region IDs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreatePortsForClickHouse', 'summary' => 'Enables the MySQL or HTTPS port for a specified ApsaraDB for ClickHouse cluster.', 'description' => '> You must manually enable the MySQL port for community-compatible clusters of version 20.8 or later that were created before December 1, 2021. For clusters created on or after this date, the MySQL port is enabled automatically.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreatePortsForClickHouse'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreatePortsForClickHouse', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', ], 'CreateRDSToClickhouseDb' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '45979', 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ 'name' => 'DbClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-2ze5zeyl72188****'], ], [ 'name' => 'ClickhousePort', 'in' => 'query', 'schema' => ['description' => 'The port number of the ApsaraDB for ClickHouse cluster.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '8123'], ], [ 'name' => 'CkUserName', 'in' => 'query', 'schema' => ['description' => 'The database account of the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user1'], ], [ 'name' => 'CkPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the database account of the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Aa'], ], [ 'name' => 'RdsId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rm-8vb989qj9roh0****'], ], [ 'name' => 'RdsPort', 'in' => 'query', 'schema' => ['description' => 'The port number of the ApsaraDB RDS for MySQL instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3306'], ], [ 'name' => 'RdsVpcId', 'in' => 'query', 'schema' => ['description' => 'The VPC ID of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vpc-2zen93xryil99jsfy****'], ], [ 'name' => 'RdsUserName', 'in' => 'query', 'schema' => ['description' => 'The database account of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user2'], ], [ 'name' => 'RdsPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the database account of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Rr'], ], [ 'name' => 'SkipUnsupported', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to skip unsupported table schemas. Valid values:'."\n" ."\n" .'- **true**: Skip.'."\n" ."\n" .'- **false**: Do not skip.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], ], [ 'name' => 'LimitUpper', 'in' => 'query', 'schema' => ['description' => 'The maximum number of rows to sync per second.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '50000'], ], [ 'name' => 'SynDbTables', 'in' => 'query', 'schema' => ['description' => 'The tables to sync.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '[{"Schema":"recommend","Tables":["mr_platform_cpm","mr_platform_ecpm","p_monitor_record"]}]'], ], [ 'name' => 'RdsVpcUrl', 'in' => 'query', 'schema' => ['description' => 'The internal endpoint of the ApsaraDB RDS instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rm-bp16t9h3999xb0a7****.mysql.rds.aliyuncs.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '66676F54-1994-5DCF-993F-74536649628A'], 'Status' => ['description' => 'Indicates whether the task was created. Valid values:'."\n" ."\n" .'- **1**: The task was created.'."\n" ."\n" .'- **0**: The task failed to be created because of duplicate tables. The duplicate tables are returned in the **RepeatedDbs** parameter.'."\n" ."\n" .'- **-1**: The task failed to be created. The error message is returned in the **ErrorMsg** parameter.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], 'ErrorMsg' => ['description' => 'The reason for the creation failure. This parameter is returned only if the value of the Status parameter is **-1**.', 'type' => 'string', 'title' => '', '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' => 'The duplicate tables in the sync task.', 'type' => 'array', 'items' => ['description' => 'The duplicate tables in the sync task. This parameter is returned only if the value of the **Status** parameter is **0**.', 'type' => 'string', 'title' => '', 'example' => '["mr_platform_cpm","mr_platform_ecpm"]'], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateRDSToClickhouseDb', 'summary' => 'You can call the CreateRDSToClickhouseDb operation to create a sync task for an ApsaraDB for ClickHouse Community-Compatible Edition cluster.', 'description' => '> This operation applies only to ApsaraDB for ClickHouse Community-Compatible Edition clusters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateRDSToClickhouseDb'], ], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'CreateSLB' => [ 'summary' => 'Calls the CreateSLB operation to attach a Server Load Balancer (SLB) instance to a specified ApsaraDB for ClickHouse Community-Compatible Edition cluster.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '143538', 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Call the [DescribeDBClusters](~~170879~~) operation to obtain the cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-uf6bnitmve5n0****'], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => ['type' => 'string', 'default' => 'clickhouse', 'description' => 'The product code.', 'required' => false, 'title' => '', 'example' => 'clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D'], ], 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateSLB', 'description' => '## Usage notes'."\n" ."\n" .'An SLB instance is a network-layer dependency that provides services for external connections and supports failover. It attaches a domain name to the IP addresses of ClickHouse nodes. The SLB instance balances and forwards cluster requests to internal nodes to distribute traffic in a multi-node deployment. It also performs health checks on backend nodes. If a node becomes unavailable, the SLB instance checks its health status and automatically isolates it. This ensures that request traffic is distributed to active nodes.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateSLB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9A23C87D-87DF-4DA0-A50E-CB13F4F7923D\\"\\n}","type":"json"}]', ], 'CreateSQLAccount' => [ 'summary' => 'Call the CreateSQLAccount operation to create a privileged or standard account for an ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '152741', 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY', 'FEATUREclickhouseL1079N'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1p816075e21****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the database account.'."\n" ."\n" .'- The name must be unique.'."\n" ."\n" .'- It must consist of lowercase letters, digits, or underscores (\\_).'."\n" ."\n" .'- It must start with a lowercase letter and end with a lowercase letter or a digit.'."\n" ."\n" .'- It must be 2 to 64 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The password for the database account.'."\n" ."\n" .'- It must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- The following characters are special characters: !@#$%^&\\*()\\_+-='."\n" ."\n" .'- It must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'Test1234', 'title' => ''], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the database account.'."\n" ."\n" .'- It cannot start with http\\:// or https\\://.'."\n" ."\n" .'- It can be 0 to 256 characters in length.', 'type' => 'string', 'example' => 'For testing', 'required' => false, 'title' => ''], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => ['description' => 'The type of the database account. Valid values:'."\n" ."\n" .'- **Super**: a privileged account.'."\n" ."\n" .'- **Normal**: a standard account.', 'type' => 'string', 'required' => true, 'example' => 'Super', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76'], ], 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\"\\n}","type":"json"}]', 'title' => 'CreateSQLAccount', 'description' => '> This operation applies only to community-compatible clusters that run version 20.8 or later and were created after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '8', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSQLAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateSQLAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], ], 'translator' => 'machine', ], 'CreateServiceLinkedRole' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '19426', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateServiceLinkedRole', 'summary' => 'Creates a service-linked role.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateServiceLinkedRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-FFEC-5023-B4E5-3BD1B67837E0\\"\\n}","type":"json"}]', ], 'DeleteAccount' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '19427', 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DeleteAccount', 'summary' => 'Deletes a database account from an ApsaraDB for ClickHouse cluster.', 'description' => '> After a database account is deleted, you cannot use it to connect to ApsaraDB for ClickHouse. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteAccount'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', ], 'DeleteBackupPolicy' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '173183', 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], ], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['type' => 'integer', 'format' => 'int32', 'title' => '', 'description' => 'The number of records to return on each page. Valid values: 1 to **100**. Default value: **30**.', 'required' => false, 'example' => '30'], ], [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['type' => 'string', 'title' => '', 'description' => 'A client token used to ensure the idempotence of the request. The value must be a string that contains a maximum of 64 ASCII characters and cannot contain non-ASCII characters.', 'required' => false, 'example' => 'ETnLKlblzczshOTUbOCz****'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => 'The cluster ID.'."\n" ."\n" .'> You can call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'required' => false, 'title' => '', 'example' => 'cc-bp1t9lbb7a4z7****'], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => ['type' => 'string', 'default' => 'clickhouse', 'description' => 'The product name.', 'required' => false, 'title' => '', 'example' => 'clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F34'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DeleteBackupPolicy', 'summary' => 'Deletes the backup policy for a community-compatible ApsaraDB for ClickHouse cluster.', 'description' => '> The data backup feature is available only for ApsaraDB for ClickHouse clusters running version 21.8 or later.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F34\\"\\n}","type":"json"}]', ], 'DeleteDBCluster' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '19428', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the pay-as-you-go cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DeleteDBCluster', 'summary' => 'Deletes a specified pay-as-you-go ApsaraDB for ClickHouse cluster.', 'description' => '>'."\n" ."\n" .'After a cluster is deleted, all data in the cluster is deleted and cannot be recovered. Proceed with caution.'."\n" ."\n" .'>', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteDBCluster'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteDBCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","type":"json"}]', ], 'DeleteSLB' => [ 'summary' => 'Releases a Server Load Balancer (SLB) instance for a specified ApsaraDB for ClickHouse Community-Compatible cluster.', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '142683', 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to view the cluster ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-uf6bnitmve5n0****'], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => ['type' => 'string', 'default' => 'clickhouse', 'description' => 'The product code.', 'required' => false, 'title' => '', 'example' => 'clickhouse'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The returned parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DeleteSLB', 'description' => '## Usage notes'."\n" ."\n" .'After you release the SLB instance, the system performs simple load balancing based on the domain name. Health checks are no longer performed on nodes at the request routing layer. This may cause normal requests to be routed to unavailable nodes, which can result in read and write failures.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteSLB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', ], 'DeleteSyndb' => [ 'summary' => 'Deletes a database synchronization task.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '47744', 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ 'name' => 'DbClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp158i5wvj436****'], ], [ 'name' => 'SynDb', 'in' => 'query', 'schema' => ['description' => 'The ApsaraDB RDS for MySQL database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'database'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2C7393F1-5FD1-5CEE-A2EA-270A2CF99693'], 'Status' => ['description' => 'Indicates whether the deletion was successful. Valid values:'."\n" ."\n" .'- **true**: The deletion was successful.'."\n" ."\n" .'- **false**: The deletion failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ErrorMsg' => ['description' => '- This parameter is not returned if **Status** is **true**.'."\n" ."\n" .'- If **Status** is **false**, this parameter indicates the reason for the failure.', 'type' => 'string', 'title' => '', 'example' => 'ClickHouse exception, code: 49, host: 100.100.xx.xx, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n'], 'ErrorCode' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DeleteSyndb', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteSyndb'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteSyndb', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeAccountAuthority' => [ 'summary' => 'Queries the permissions of a database account.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19430', 'abilityTreeNodes' => ['FEATUREclickhouseL1079N'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the latest region list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1p816075e21****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The database account name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DdlAuthority' => ['description' => 'Indicates whether the account has DDL permissions. Valid values:'."\n" ."\n" .'- **true**: DDL permissions are granted.'."\n" ."\n" .'- **false**: DDL permissions are denied.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'DmlAuthority' => ['description' => 'The DML permission level for the account. Valid values:'."\n" ."\n" .'- **all**: read, write, and settings permissions.'."\n" ."\n" .'- **readOnly,modify**: read and settings permissions.', 'type' => 'string', 'example' => 'all', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''], 'TotalDatabases' => [ 'description' => 'A list of all databases in the cluster.', 'type' => 'array', 'items' => ['description' => 'A comma-separated string of all database names, returned as a single element in an array.', 'type' => 'string', 'example' => 'db1,db2', 'title' => ''], 'title' => '', 'example' => '', ], 'TotalDictionaries' => [ 'description' => 'A list of all dictionaries in the cluster.', 'type' => 'array', 'items' => ['description' => 'A comma-separated string of all dictionary names, returned as a single element in an array.', 'type' => 'string', 'example' => 'dt1,dt2', 'title' => ''], 'title' => '', 'example' => '', ], 'AllowDictionaries' => [ 'description' => 'The list of authorized dictionaries.', 'type' => 'array', 'items' => ['description' => 'The name of a dictionary.', 'type' => 'string', 'example' => 'dt1', 'title' => ''], 'title' => '', 'example' => '', ], 'AllowDatabases' => [ 'description' => 'The list of authorized databases.', 'type' => 'array', 'items' => ['description' => 'The name of a database.', 'type' => 'string', 'example' => 'db1', 'title' => ''], 'title' => '', 'example' => '', ], 'AccountName' => ['description' => 'The database account name.', 'type' => 'string', 'example' => 'test', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeAccountAuthority', 'description' => 'This API applies only to clusters of v21.8 or earlier. For clusters running a later version, you must use a privileged account and execute SQL statements to modify the permissions of a regular user.', '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' => 'Describes the database accounts of a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19431', 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The name of the database account.'."\n" ."\n" .'> If this parameter is not specified, the operation queries information about all database accounts.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'testAccount'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'title' => '', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '30'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], 'Accounts' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Account' => [ 'description' => 'The list of database accounts.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'AccountStatus' => ['description' => 'The status of the database account. Valid values:'."\n" ."\n" .'- **Creating**: The account is being created.'."\n" ."\n" .'- **Available**: The account is active.'."\n" ."\n" .'- **AuthorityModifying**: The permissions of the account are being modified.'."\n" ."\n" .'- **Deleting**: The account is being deleted.'."\n" ."\n" .'> Only database accounts that are configured using XML files can be in the **AuthorityModifying** state.', 'type' => 'string', 'title' => '', 'example' => 'Creating'], 'AccountDescription' => ['description' => 'The description of the database account.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'AccountType' => ['description' => 'The type of the database account. Valid values:'."\n" ."\n" .'- **Super**: a privileged account.'."\n" ."\n" .'- **Normal**: a standard account.', 'type' => 'string', 'title' => '', 'example' => 'Super'], 'AccountName' => ['description' => 'The name of the database account.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'ConfigType' => ['description' => 'The configuration method of the database account.', 'type' => 'string', 'title' => '', 'example' => 'SQL'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeAccounts', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeAccounts'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAccounts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeActiveOperationMaintainConf' => [ 'summary' => 'Queries the active Operations and Maintenance (O&M) configuration of a ClickHouse instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HasConfig' => ['description' => 'Indicates whether a configuration is set.'."\n" ."\n" .'- 1: A configuration is set.'."\n" ."\n" .'- 0: No configuration is set.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D', 'title' => ''], 'Config' => [ 'type' => 'object', 'properties' => [ 'CycleType' => ['description' => 'The cycle type.'."\n" ."\n" .'- Month'."\n" ."\n" .'- Week', 'type' => 'string', 'example' => 'Week', 'title' => ''], 'Status' => ['description' => 'The status of the configuration. A value of 1 indicates that the configuration is enabled. A value of 2 indicates that the configuration is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'ModifiedTime' => ['description' => 'The time when the configuration was last modified.', 'type' => 'string', 'example' => '2025-06-27T07:12:53Z', 'title' => ''], 'MaintainStartTime' => ['description' => 'The start time of the maintenance window.', 'type' => 'string', 'example' => '18:00Z', 'title' => ''], 'MaintainEndTime' => ['description' => 'The end time of the maintenance window.', 'type' => 'string', 'example' => '22:00Z', 'title' => ''], 'CycleTime' => ['description' => 'The day of the cycle.'."\n" ."\n" .'- If CycleType is Month, this parameter returns one or more numbers from 1 to 28 that indicate the day of the month. Multiple numbers are separated by commas (,).'."\n" ."\n" .'- If CycleType is Week, this parameter returns one or more numbers from 1 to 7 that indicate the day of the week. Multiple numbers are separated by commas (,).', 'type' => 'string', 'example' => '1', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the configuration was created.', 'type' => 'string', 'example' => '2025-03-18T06:51:11+08:00', 'title' => ''], ], 'description' => 'The active O\\&M configuration items.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeActiveOperationMaintainConf', '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' => 'Region', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', 'schema' => ['description' => 'The task type. Valid values:'."\n" ."\n" .'- **rds\\_apsaradb\\_upgrade**: Minor version upgrade.'."\n" ."\n" .'- **all**: All task types.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'all', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'ProductId', 'in' => 'query', 'schema' => ['description' => 'The product ID.', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'title' => ''], ], [ 'name' => 'DbType', 'in' => 'query', 'schema' => [ 'description' => 'The database type.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'title' => '', ], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The task status. This parameter is used to filter tasks.'."\n" ."\n" .'- **-1:** All tasks.'."\n" ."\n" .'- **3:** Tasks to be processed.'."\n" ."\n" .'- **4:** Tasks in progress.'."\n" ."\n" .'- **5:** Successfully completed tasks.'."\n" ."\n" .'- **6:** Failed tasks.'."\n" ."\n" .'- **7:** Canceled tasks.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', 'title' => ''], ], [ 'name' => 'InsName', 'in' => 'query', 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp191w*******', 'title' => ''], ], [ 'name' => 'AllowChange', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the time can be changed. Valid values:'."\n" ."\n" .'- **0**: The time cannot be changed.'."\n" ."\n" .'- **1**: The time can be changed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', 'title' => ''], ], [ 'name' => 'AllowCancel', 'in' => 'query', 'schema' => ['description' => 'Specifies whether the task can be canceled. Valid values:'."\n" ."\n" .'- **0**: The task cannot be canceled.'."\n" ."\n" .'- **1**: The task can be canceled.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '-1', 'title' => ''], ], [ 'name' => 'ChangeLevel', 'in' => 'query', 'schema' => ['description' => 'The task level. Valid values:'."\n" ."\n" .'- **all** (Default): All levels.'."\n" ."\n" .'- **S0**: Returns tasks for fixing exceptions.'."\n" ."\n" .'- **S1**: Returns tasks for system O\\&M.', 'type' => 'string', 'required' => false, 'example' => 'all', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalRecordCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The running status of the task. Return values:'."\n" ."\n" .'- **2**: Waiting for the user to specify a time.'."\n" ."\n" .'- **3**: To be processed.'."\n" ."\n" .'- **4**: In progress.'."\n" ."\n" .'- **5**: Successful.'."\n" ."\n" .'- **6**: Failed.'."\n" ."\n" .'- **7**: Canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'ChangeLevelEn' => ['description' => 'The English name of the change level.', 'type' => 'string', 'example' => 'S1', 'title' => ''], 'TaskType' => ['description' => 'The O\\&M event task type.', 'type' => 'string', 'example' => 'rds_apsaradb_upgrade', 'title' => ''], 'InsName' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => 'cc-bp191w*******'."\n", 'title' => ''], 'Region' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], 'ImpactZh' => ['description' => 'The business impact in Chinese.', 'type' => 'string', 'example' => '实例闪断。', 'title' => ''], 'CreatedTime' => ['description' => 'The creation time. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z'."\n", 'title' => ''], 'SwitchTime' => ['description' => 'The time when the backend initiates the switchover. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).', 'type' => 'string', 'example' => '2018-05-30T14:30:00Z'."\n", 'title' => ''], 'ChangeLevelZh' => ['description' => 'The event level in Chinese.', 'type' => 'string', 'example' => '系统运维'."\n", 'title' => ''], 'Deadline' => ['description' => 'The latest time to which the task execution time can be adjusted. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).', 'type' => 'string', 'example' => '2018-05-30T23:59:59Z'."\n", 'title' => ''], 'PrepareInterval' => ['description' => 'The preparation time required between the start time and the switchover time. The format is HH:mm:ss.', 'type' => 'string', 'example' => '04:00:00'."\n", 'title' => ''], 'Impact' => ['description' => 'The event impact.', 'type' => 'string', 'example' => 'TransientDisconnection'."\n", 'title' => ''], 'TaskTypeZh' => ['description' => 'The task reason in Chinese.', 'type' => 'string', 'example' => '小版本升级'."\n", 'title' => ''], 'CurrentAVZ' => ['description' => 'The current zone.', 'type' => 'string', 'example' => 'cn-beijing-h'."\n", 'title' => ''], 'AllowChange' => ['description' => 'Specifies whether the time can be changed. Return values:'."\n" ."\n" .'- **-1**: All'."\n" ."\n" .'- **0**: No'."\n" ."\n" .'- **1**: Yes', 'type' => 'string', 'example' => '-1', 'title' => ''], 'DbVersion' => ['description' => 'The kernel version of the cluster.', 'type' => 'string', 'example' => '23.8', 'title' => ''], 'ImpactEn' => ['description' => 'The event impact in English.', 'type' => 'string', 'example' => 'Transient instance disconnection'."\n", 'title' => ''], 'InsComment' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'StartTime' => ['description' => 'The time when the backend executes the task. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).', 'type' => 'string', 'example' => '2025-04-22T01:06Z', 'title' => ''], 'ModifiedTime' => ['description' => 'The modification time. The time is in UTC format (YYYY-MM-DDTHH:mm:ssZ).', 'type' => 'string', 'example' => '2023-11-15T06:17:54Z', 'title' => ''], 'AllowCancel' => ['description' => 'Specifies whether the task can be canceled. Return values:'."\n" ."\n" .'- **-1**: All'."\n" ."\n" .'- **0**: No'."\n" ."\n" .'- **1**: Yes', 'type' => 'string', 'example' => '-1', 'title' => ''], 'DbType' => ['description' => 'The database type.', 'type' => 'string', 'example' => 'clickhouse', 'title' => ''], 'ChangeLevel' => ['description' => 'The event level code.'."\n" ."\n" .'- **S1**: System O\\&M.'."\n" ."\n" .'- **S0**: Threat fixing.', 'type' => 'string', 'example' => 'S1', 'title' => ''], 'TaskTypeEn' => ['description' => 'The task type in English.', 'type' => 'string', 'example' => 'Minor version update'."\n", 'title' => ''], 'ResultInfo' => ['description' => 'The description of the execution result.', 'type' => 'string', 'example' => 'userCancel', 'title' => ''], 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '11', 'title' => ''], 'SubInsNames' => [ 'type' => 'array', 'items' => ['description' => 'A sub-instance ID.', 'type' => 'string', 'example' => '1', 'title' => ''], 'description' => 'The sub-instance IDs.', 'title' => '', 'example' => '', ], 'TaskParams' => ['description' => 'The O\\&M event parameters.', 'type' => 'string', 'example' => '{'."\n" .' "Action": "UpgradeDBInstance"'."\n" .'}', 'title' => ''], ], 'description' => 'The list of O\\&M tasks.', 'title' => '', 'example' => '', ], 'description' => 'The list of O\\&M tasks.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeActiveOperationTasks', 'summary' => 'Queries the active operation tasks of a ClickHouse instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeActiveOperationTasks', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => 'Describes all databases, tables, and columns in an instance.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19432', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'SchemaName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'database'], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'table'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], 'Tables' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Table' => [ 'description' => 'The table information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'title' => '', 'example' => 'table'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Columns' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Column' => [ 'description' => 'The column information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The column type.', 'type' => 'string', 'title' => '', 'example' => 'String'], 'ColumnName' => ['description' => 'The column name.', 'type' => 'string', 'title' => '', 'example' => 'name'], 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'title' => '', 'example' => 'table'], 'AutoIncrementColumn' => ['description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" ."\n" .'- **true**: The column is an auto-increment column.'."\n" ."\n" .'- **false**: The column is not an auto-increment column.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'PrimaryKey' => ['description' => 'Indicates whether the column is a primary key. Valid values:'."\n" ."\n" .'- **true**: The column is a primary key.'."\n" ."\n" .'- **false**: The column is not a primary key.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Schemas' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Schema' => [ 'description' => 'The database information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeAllDataSource', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAllDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeAllDataSources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19433', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'SchemaName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'database'], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'table'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '75EA41D7-025A-50A6-9287-359A91399F1E'], 'Tables' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Table' => [ 'description' => 'The table information.', 'type' => 'array', 'items' => [ 'description' => 'All tables that meet the specified criteria.', 'type' => 'object', 'properties' => [ 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'title' => '', 'example' => 'table'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Columns' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Column' => [ 'description' => 'The column information.', 'type' => 'array', 'items' => [ 'description' => 'The column information.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The column type.', 'type' => 'string', 'title' => '', 'example' => 'String'], 'ColumnName' => ['description' => 'The column name.', 'type' => 'string', 'title' => '', 'example' => 'name'], 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'title' => '', 'example' => 'table'], 'AutoIncrementColumn' => ['description' => 'Indicates if the column auto-increments. Valid values:'."\n" ."\n" .'- **true**: The column auto-increments.'."\n" ."\n" .'- **false**: The column does not auto-increment.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'PrimaryKey' => ['description' => 'Indicates if the column is a primary key. Valid values:'."\n" ."\n" .'- **true**: The column is a primary key.'."\n" ."\n" .'- **false**: The column is not a primary key.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Schemas' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Schema' => [ 'description' => 'The database information.', 'type' => 'array', 'items' => [ 'description' => 'The list of databases.', 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeAllDataSources', 'summary' => 'Queries the details of all data sources.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAllDataSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeAutoRenewAttribute' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '209424', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-beijing'], ], [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'description' => 'The cluster ID.', 'title' => '', 'example' => 'cc-uf6g4417bo*****'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'description' => 'The number of entries per page.', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'description' => 'The page number.', 'title' => '', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E*******'], 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The page number.', 'title' => '', 'example' => '1'], 'PageRecordCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The number of entries on the current page.', 'title' => '', 'example' => '5'], 'TotalRecordCount' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The total number of entries.', 'title' => '', 'example' => '51'], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'AutoRenewAttribute' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['type' => 'string', 'description' => 'The cluster ID.', 'title' => '', 'example' => 'cc-2ze57pg09*****'], 'PeriodUnit' => ['type' => 'string', 'description' => 'The subscription duration unit. Valid values: Month and Year.', 'title' => '', 'example' => 'Year'], 'Duration' => ['type' => 'integer', 'format' => 'int32', 'description' => 'The subscription duration.', 'title' => '', 'example' => '1'], 'RenewalStatus' => ['type' => 'string', 'description' => 'The renewal status. Valid values:'."\n" ."\n" .'- **AutoRenewal**: The cluster is automatically renewed.'."\n" ."\n" .'- **Normal**: The cluster is manually renewed.'."\n" ."\n" .'- **NotRenewal**: The cluster is not renewed upon expiration.', 'title' => '', 'example' => 'AutoRenewal'], 'AutoRenewEnabled' => ['type' => 'boolean', 'description' => 'Indicates whether auto-renewal is enabled. Valid values:'."\n" ."\n" .'- **true**: Enabled.'."\n" ."\n" .'- **false**: Disabled.', 'title' => '', 'example' => ''], 'RegionId' => ['type' => 'string', 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-beijing'], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The auto-renewal information.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeAutoRenewAttribute', 'summary' => 'Queries the auto-renewal status of a ClickHouse Community-Compatible cluster.', '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\\": false,\\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' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1qx68m06981****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'PreferredBackupPeriod' => ['description' => 'The backup cycle. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**', 'type' => 'string', 'title' => '', 'example' => 'Monday'], 'Switch' => ['description' => 'Indicates whether the backup feature is enabled. Valid values:'."\n" ."\n" .'- **true**: The backup feature is enabled.'."\n" ."\n" .'- **false**: The backup feature is disabled.', 'type' => 'string', 'title' => '', 'example' => 'true'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'PreferredBackupTime' => ['description' => 'The backup time in UTC.', 'type' => 'string', 'title' => '', 'example' => '15:00Z-16:00Z'], 'BackupRetentionPeriod' => ['description' => 'The backup retention period. Default value: 7. Valid values: 7 to 730. Unit: day.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '7'], 'BackupSize' => ['description' => 'The backup size. Unit: MB.', 'type' => 'string', 'title' => '', 'example' => '123124'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeBackupPolicy', 'summary' => 'Queries the backup settings for a specified ApsaraDB for ClickHouse cluster.', 'description' => '> Data backup is supported for ApsaraDB for ClickHouse clusters running version 20.3, 20.8, or 21.8.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => 'Queries the backup sets of a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '19436', 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp1qx68m06981****', 'title' => ''], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the backup task.', 'type' => 'string', 'required' => false, 'example' => '117403****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-21T16:00Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-25T16:00Z', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" .'- **50**'."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" .'- **50**'."\n" .'- **100**', 'type' => 'string', 'example' => '30', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Items' => [ 'description' => 'The list of backup sets.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp1qx68m06981****', 'title' => ''], 'BackupStatus' => ['description' => 'The backup status. Valid values:'."\n" ."\n" .'- **Success**: The backup is complete.'."\n" .'- **Failure**: The backup failed.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'BackupType' => ['description' => 'The backup type. Valid values:'."\n" ."\n" .'- **FullBackup**: full backup.'."\n" .'- **IncrementalBackup**: incremental backup.', 'type' => 'string', 'example' => 'IncrementalBackup', 'title' => ''], 'BackupStartTime' => ['description' => 'The time when the backup started. Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2021-11-22T18:28:22Z', 'title' => ''], 'BackupSize' => ['description' => 'The backup size.'."\n" .'Unit: MB.', 'type' => 'integer', 'format' => 'int64', 'example' => '131072', 'title' => ''], 'BackupEndTime' => ['description' => 'The time when the backup ended.'."\n" .'Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2021-11-22T18:28:41Z', 'title' => ''], 'BackupSetInfo' => ['description' => 'The number of nodes in the cluster.'."\n" ."\n" .'- Single-replica edition: valid values: 1 to 48.'."\n" .'- Master-replica cluster: valid values: 1 to 24.', 'type' => 'string', 'example' => '{"shard_count": 4}', 'title' => ''], 'BackupId' => ['description' => 'The ID of the backup task.', 'type' => 'string', 'example' => '117403****', 'title' => ''], 'BackupMethod' => ['description' => 'The backup method. The value is **Physical**, which indicates physical backup.', 'type' => 'string', 'example' => 'Physical', 'title' => ''], 'ExpireDate' => ['description' => 'The expiration time of the backup set.'."\n" .'Format: yyyy-MM-ddTHH:mmZ (UTC).', 'type' => 'string', 'example' => '2022-07-22T18:28:41Z', 'title' => ''], 'BackupScheduleType' => ['description' => 'The backup type. Valid values: manual (manual backup) and scheduled (automatic backup).', 'type' => 'string', 'example' => 'manual', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], '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 \\"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}","type":"json"}]', 'title' => 'Query backup sets', 'description' => '>Only ApsaraDB for ClickHouse clusters of version 21.8 or later support the data backup feature.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeBackups'], ], ], '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' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19437', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-2zeux3ua25242****'], ], [ 'name' => 'SchemaName', 'in' => 'query', 'schema' => ['description' => 'The name of the database. You can call the [DescribeSchemas](~~350931~~) operation to query database names.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'database'], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => ['description' => 'The name of the table. You can call the [DescribeTables](~~350932~~) operation to query table names.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'table'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '66428721-FFEC-5023-B4E5-3BD1B67837E0'], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Column' => [ 'description' => 'The column information.', 'type' => 'array', 'items' => [ 'description' => 'The column information.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The column type.', 'type' => 'string', 'title' => '', 'example' => 'String'], 'ColumnName' => ['description' => 'The column name.', 'type' => 'string', 'title' => '', 'example' => 'name'], 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'title' => '', 'example' => 'table'], 'AutoIncrementColumn' => ['description' => 'Indicates whether the column is an auto-increment column. Valid values:'."\n" ."\n" .'- **true**: The column is an auto-increment column.'."\n" ."\n" .'- **false**: The column is not an auto-increment column.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-2zeux3ua25242****'], 'PrimaryKey' => ['description' => 'Indicates whether the column is a primary key. Valid values:'."\n" ."\n" .'- **true**: The column is a primary key.'."\n" ."\n" .'- **false**: The column is not a primary key.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeColumns', 'summary' => 'You can view columns.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeColumns', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeConfigHistory' => [ 'summary' => 'Call the DescribeConfigHistory operation to view the configuration parameter change history of a community-compatible ApsaraDB for ClickHouse cluster.', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '145141', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Call the [DescribeDBClusters](~~170879~~) operation to query the information about all clusters in a specific region, including cluster IDs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp1p816075e21****'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start of the time range to query. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2022-08-11T06:27:00Z'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '2022-08-22T10:06:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], 'ConfigHistoryItems' => [ 'description' => 'The change history of the configuration parameters.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Time' => ['description' => 'The time when the change was made. Use the yyyy-MM-ddTHH:mm:ssZ format. The time is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-08-22T10:00:00Z'], 'OwnerId' => ['description' => 'The UID of the Alibaba Cloud account.', 'type' => 'string', 'title' => '', 'example' => '253460731706911258'], 'Reason' => ['description' => 'The reason for the parameter change.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'Success' => ['description' => 'Indicates whether the parameter change took effect. Valid values:'."\n" ."\n" .'- **true**: The change took effect.'."\n" ."\n" .'- **false**: The change did not take effect.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ChangeId' => ['description' => 'The ID of the change record.', 'type' => 'string', 'title' => '', 'example' => '1'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'DescribeConfigHistory', 'description' => '> This operation supports only community-compatible clusters that are created after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeConfigHistory', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeConfigVersionDifference' => [ 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '145140', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Call the [DescribeDBClusters](~~170879~~) operation to query the IDs of all clusters in the destination region.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp1tm8zf130ew****'], ], [ 'name' => 'ChangeId', 'in' => 'query', 'schema' => ['description' => 'The ID of the change record. Call the [DescribeConfigHistory](~~452209~~) operation to query the IDs of change records.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], 'OldConfigXML' => ['description' => 'The configuration parameters before the change.', 'type' => 'string', 'title' => '', 'example' => '"'."\n" .''."\n" .' 300'."\n" .' 4096'."\n" .' '."\n" .' debug'."\n" .' 1000M'."\n" .' '."\n" .' 5368709120'."\n" .' 150'."\n" .' 4096'."\n" .' 0'."\n" .' 0'."\n" .' '."\n" .' 256'."\n" .' auto'."\n" .' 100'."\n" .' 1'."\n" .' '."\n" .' 1717986918'."\n" .'"'], 'NewConfigXML' => ['description' => 'The configuration parameters after the change.', 'type' => 'string', 'title' => '', 'example' => '"'."\n" .''."\n" .' 400'."\n" .' 4096'."\n" .' '."\n" .' debug'."\n" .' 1000M'."\n" .' '."\n" .' 5368709120'."\n" .' 201'."\n" .' 4096'."\n" .' 0'."\n" .' 0'."\n" .' '."\n" .' 256'."\n" .' auto'."\n" .' 100'."\n" .' 1'."\n" .' '."\n" .' 1717986918'."\n" .'"'], ], 'example' => '', ], ], ], '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' => 'DescribeConfigVersionDifference', 'summary' => 'Call the DescribeConfigVersionDifference operation to compare the parameter values of an ApsaraDB for ClickHouse community-compatible cluster before and after a configuration change.', 'description' => '> This operation applies only to community-compatible clusters that were created after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeConfigVersionDifference', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"OldConfigXML\\": \\"\\\\\\"\\\\n\\\\n 300\\\\n 4096\\\\n \\\\n debug\\\\n 1000M\\\\n \\\\n 5368709120\\\\n 150\\\\n 4096\\\\n 0\\\\n 0\\\\n \\\\n 256\\\\n auto\\\\n 100\\\\n 1\\\\n \\\\n 1717986918\\\\n\\\\\\"\\",\\n \\"NewConfigXML\\": \\"\\\\\\"\\\\n\\\\n 400\\\\n 4096\\\\n \\\\n debug\\\\n 1000M\\\\n \\\\n 5368709120\\\\n 201\\\\n 4096\\\\n 0\\\\n 0\\\\n \\\\n 256\\\\n auto\\\\n 100\\\\n 1\\\\n \\\\n 1717986918\\\\n\\\\\\"\\"\\n}","type":"json"}]', ], 'DescribeDBClusterAccessWhiteList' => [ 'summary' => 'Queries the IP address whitelist of a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19438', 'abilityTreeNodes' => ['FEATUREclickhouseW0KOAC'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBClusterAccessWhiteList' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'IPArray' => [ 'description' => 'The list of whitelist groups.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterIPArrayAttribute' => ['description' => 'The property of the whitelist group.', 'type' => 'string', 'title' => '', 'example' => 'default'], 'SecurityIPList' => ['description' => 'The list of IP addresses in the whitelist group.', 'type' => 'string', 'title' => '', 'example' => '192.168.xx.xx,192.168.xx.xx'], 'DBClusterIPArrayName' => ['description' => 'The name of the whitelist group.', 'type' => 'string', 'title' => '', 'example' => 'default'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '905F13A4-5097-4897-A84D-527EC75FFF4F'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeDBClusterAccessWhiteList', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAccessWhiteList'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterAccessWhiteList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterAttribute' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '19439', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query the details of all clusters in a region, including their IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'DBCluster' => [ 'description' => 'Details about the cluster.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp10tr8k9qasioaty****', 'title' => ''], 'SupportBackup' => ['description' => 'Whether the cluster supports data backup. Valid values:'."\n" ."\n" .'- `1`: Supported.'."\n" ."\n" .'- `2`: Not supported.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SupportOss' => ['description' => 'Whether the cluster supports tiered storage for hot and cold data. Valid values:'."\n" ."\n" .'- `1`: Supported.'."\n" ."\n" .'- `2`: Not supported.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'EncryptionType' => ['description' => 'The encryption type. Valid values:'."\n" ."\n" .'- `CloudDisk`: disk encryption.'."\n" ."\n" .'- `off`: Encryption is disabled.', 'type' => 'string', 'example' => 'CloudDisk', 'title' => ''], 'DBNodeCount' => ['description' => 'The number of nodes in the cluster.'."\n" ."\n" .'- For a single-replica edition, the value range is 1 to 48.'."\n" ."\n" .'- For a dual-replica edition, the value range is 1 to 24.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'MaintainTime' => ['description' => 'The maintenance window of the cluster. The time is in the `HH:mmZ-HH:mmZ` format and is in UTC.'."\n" ."\n" .'For example, `00:00Z-01:00Z` indicates that the maintenance window is from 00:00 to 01:00 (UTC), which corresponds to 08:00 to 09:00 in Beijing time (UTC+8).', 'type' => 'string', 'example' => '00:00Z-01:00Z', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the cluster, in `yyyy-MM-ddTHH:mm:ssZ` format (UTC).', 'type' => 'string', 'example' => '2021-12-13T11:33:11Z', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- `Postpaid`: pay-as-you-go.'."\n" ."\n" .'- `Prepaid`: subscription.', 'type' => 'string', 'example' => 'Prepaid', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'A list of tags.', 'type' => 'array', 'items' => [ 'description' => 'A tag object.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'department', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'it', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => 'The tags of the cluster.', 'title' => '', 'example' => '', ], 'PublicConnectionString' => ['description' => 'The public endpoint.', 'type' => 'string', 'example' => 'cc-bp1199ya710s7****.public.clickhouse.ads.aliyuncs.com', 'title' => ''], 'StorageType' => ['description' => 'The storage type. Valid values:'."\n" ."\n" .''."\n" ."\n" .'- `CloudESSD_PL0`: ESSD PL0 disk.'."\n" ."\n" .''."\n" ."\n\n" .'- `CloudESSD`: ESSD PL1 disk.'."\n" ."\n" .'- `CloudESSD_PL2`: ESSD PL2 disk.'."\n" ."\n" .'- `CloudESSD_PL3`: ESSD PL3 disk.'."\n" ."\n" .'- `CloudEfficiency`: Ultra disk.', 'type' => 'string', 'example' => 'CloudESSD', 'title' => ''], 'Port' => ['description' => 'The HTTP port.', 'type' => 'integer', 'format' => 'int32', 'example' => '8123', 'title' => ''], 'LockMode' => ['description' => 'The lock mode of the cluster. Valid values:'."\n" ."\n" .'- `Unlock`: The cluster is not locked.'."\n" ."\n" .'- `ManualLock`: The cluster is manually locked.'."\n" ."\n" .'- `LockByExpiration`: The cluster is automatically locked upon expiration.'."\n" ."\n" .'- `LockByRestoration`: The cluster is automatically locked before a rollback.'."\n" ."\n" .'- `LockByDiskQuota`: The cluster is automatically locked because the storage is full.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'Bid' => ['description' => 'The site ID. Valid values:'."\n" ."\n" .'- `26842`: China site (aliyun.com).'."\n" ."\n" .'- `26888`: international site (alibabacloud.com).', 'type' => 'string', 'example' => '26842', 'title' => ''], 'EngineVersion' => ['description' => 'The engine version.', 'type' => 'string', 'example' => '21.8.10.19', 'title' => ''], 'IsExpired' => ['description' => 'Whether the cluster has expired. Valid values:'."\n" ."\n" .'- `true`: The cluster has expired.'."\n" ."\n" .'- `false`: The cluster has not expired.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'ScaleOutStatus' => [ 'description' => 'The data migration status.', 'type' => 'object', 'properties' => [ 'Progress' => ['description' => 'The data migration progress, as a percentage.'."\n" ."\n" .'> This parameter is returned only when the cluster is in the `SCALING_OUT` state.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Ratio' => ['description' => 'The data migration progress, displayed as `Amount of data migrated/Total data amount`.'."\n" ."\n" .'> This parameter is returned only when the cluster is in the `SCALING_OUT` state.', 'type' => 'string', 'example' => '0MB/60469MB', 'title' => ''], ], 'title' => '', 'example' => '', ], 'LbKind' => ['description' => 'The type of the load balancer.', 'type' => 'string', 'example' => 'clb', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp108z124a8o7****', 'title' => ''], 'ConnectionString' => ['description' => 'The VPC endpoint.', 'type' => 'string', 'example' => 'cc-bp1qx68m06981****.ads.rds.aliyuncs.com', 'title' => ''], 'EncryptionKey' => ['description' => 'The Key Management Service (KMS) key ID.'."\n" ."\n" .'> This parameter is empty if `EncryptionType` is set to `off`.', 'type' => 'string', 'example' => '685f416f-87c9-4554-8d3a-75b6ce25****', 'title' => ''], 'DBClusterType' => ['description' => 'The cluster type. Valid values:'."\n" ."\n" .'- `Common`: a standard cluster.'."\n" ."\n" .'- `Readonly`: a read-only cluster.'."\n" ."\n" .'- `Guard`: a disaster recovery cluster.', 'type' => 'string', 'example' => 'Common', 'title' => ''], 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'clickhouse_go_public_cn', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster, in `yyyy-MM-ddTHH:mm:ssZ` format (UTC).'."\n" ."\n" .'> This parameter is empty for pay-as-you-go clusters.', 'type' => 'string', 'example' => '2022-11-11T16:00:00Z', 'title' => ''], 'DBNodeStorage' => ['description' => 'The storage capacity per node, in GB.'."\n" ."\n" .'The value can range from 100 to 32000.'."\n" ."\n" .'> The value must be a multiple of 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'DBNodeClass' => ['description' => 'The instance type of the cluster nodes.'."\n" ."\n" .'- Valid values for a single-replica edition:'."\n" ."\n" .' - `S4-NEW`'."\n" ."\n" .' - `S8`'."\n" ."\n" .' - `S16`'."\n" ."\n" .' - `S32`'."\n" ."\n" .' - `S64`'."\n" ."\n" .' - `S104`'."\n" ."\n" .'- Valid values for a dual-replica edition:'."\n" ."\n" .' - `C4-NEW`'."\n" ."\n" .' - `C8`'."\n" ."\n" .' - `C16`'."\n" ."\n" .' - `C32`'."\n" ."\n" .' - `C64`'."\n" ."\n" .' - `C104`', 'type' => 'string', 'example' => 'C8', 'title' => ''], 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '140692647406****', 'title' => ''], 'LockReason' => ['description' => 'The reason the cluster was locked.'."\n" ."\n" .'> This parameter is empty if `LockMode` is set to `Unlock`.', 'type' => 'string', 'example' => 'DISK_FULL', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'PublicPort' => ['description' => 'The public TCP port.', 'type' => 'string', 'example' => '3306', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1n874li1t5y57wi****', 'title' => ''], 'DBClusterStatus' => ['description' => 'The cluster status. Valid values:'."\n" ."\n" .'- `Preparing`: The cluster is being prepared.'."\n" ."\n" .'- `Creating`: The cluster is being created.'."\n" ."\n" .'- `Running`: The cluster is running.'."\n" ."\n" .'- `Deleting`: The cluster is being deleted.'."\n" ."\n" .'- `SCALING_OUT`: The cluster is being scaled out.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'DBClusterNetworkType' => ['description' => 'The network type. Only VPC is supported.', 'type' => 'string', 'example' => 'vpc', 'title' => ''], 'DBClusterDescription' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'cc-bp108z124a8o7****', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'Category' => ['description' => 'The edition of the cluster. Valid values:'."\n" ."\n" .'- `Basic`: single-replica edition.'."\n" ."\n" .'- `HighAvailability`: dual-replica edition.', 'type' => 'string', 'example' => 'HighAvailability', 'title' => ''], 'Engine' => ['description' => 'The database engine.', 'type' => 'string', 'example' => 'ClickHouse', 'title' => ''], 'SupportMysqlPort' => ['description' => 'Whether the MySQL port is supported. Valid values:'."\n" ."\n" .'- `true`: Supported.'."\n" ."\n" .'- `false`: Not supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'SupportHttpsPort' => ['description' => 'Whether the HTTPS port is supported. Valid values:'."\n" ."\n" .'- `true`: Supported.'."\n" ."\n" .'- `false`: Not supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ControlVersion' => ['description' => 'The version of the backend management system. Valid values:'."\n" ."\n" .'- `v1`'."\n" ."\n" .'- `v2`', 'type' => 'string', 'example' => 'v1', 'title' => ''], 'PublicIpAddr' => ['description' => 'The IP address of the public endpoint.', 'type' => 'string', 'example' => '121.40.xx.xx', 'title' => ''], 'EngineMinorVersion' => ['description' => 'The engine\'s current minor version.', 'type' => 'string', 'example' => '1.6.0', 'title' => ''], 'EngineLatestMinorVersion' => ['description' => 'The latest minor version to which the cluster can be upgraded.', 'type' => 'string', 'example' => '1.34.0', 'title' => ''], 'MaintainAutoType' => ['description' => 'The upgrade method. A value of `false` indicates that upgrades must be performed manually.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'ExtStorageType' => ['description' => 'The extended storage type. Valid values:'."\n" ."\n" .''."\n" ."\n" .'- `CloudESSD_PL0`: ESSD PL0 disk.'."\n" ."\n" .''."\n" ."\n\n" .'- `CloudESSD`: ESSD PL1 disk.'."\n" ."\n" .'- `CloudESSD_PL2`: ESSD PL2 disk.'."\n" ."\n" .'- `CloudESSD_PL3`: ESSD PL3 disk.'."\n" ."\n" .'- `CloudEfficiency`: Ultra disk.', 'type' => 'string', 'example' => 'CloudESSD', 'title' => ''], 'ExtStorageSize' => ['description' => 'The extended storage capacity, in GB.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmyf65je6****', 'title' => ''], 'ZookeeperClass' => ['description' => 'The specifications of the ZooKeeper nodes.', 'type' => 'string', 'example' => '4 Core 8 GB', 'title' => ''], 'AppointmentRestartTime' => ['description' => 'The scheduled restart time. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.', 'type' => 'string', 'example' => '2023-11-06T12:00:00Z', 'title' => ''], 'ZoneIdVswitchMap' => ['description' => 'A map of zone IDs to vSwitch IDs for a multi-zone cluster.', 'type' => 'object', 'example' => 'cn-shanghai-f: vsw-zm0n42d5vvuo****', 'title' => ''], 'AvailableUpgradeMajorVersion' => ['description' => 'The available major versions to which the cluster can be upgraded, and their latest minor versions.', 'type' => 'object', 'example' => '{"MajorVersion":"MinorVersion"}', 'title' => ''], 'AppointmentRestartNodeTime' => ['description' => 'The scheduled time to restart specific nodes. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.', 'type' => 'string', 'example' => '2023-11-06T12:00:00Z', 'title' => ''], 'AppointmentRestartNodeList' => ['description' => 'A list of nodes that are scheduled for a restart.', 'type' => 'string', 'example' => 'ck-k1a976p3n********-****-clickhouse-s-0-r-0,ck-k1a976p3n********-****-clickhouse-s-0-r-1', 'title' => ''], 'AppointmentElectZookeeperTime' => ['description' => 'The scheduled time for a primary/secondary switchover. The time is in the `YYYY-MM-DDThh:mm:ssZ` format and is in UTC.', 'type' => 'string', 'example' => '2023-11-06T12:00:00Z', 'title' => ''], 'AppointmentElectZookeeperDisableWrite' => ['description' => 'Specifies whether to stop write operations during a primary/secondary switchover. Valid values:'."\n" ."\n" .'- `true`: Write operations are stopped for the instance during the switchover.'."\n" ."\n" .'- `false`: Write operations are not stopped for the instance during the switchover.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'VpcIpAddr' => ['description' => 'The IP address of the VPC endpoint.', 'type' => 'string', 'example' => '192.168.xx.xx', 'title' => ''], 'VpcCloudInstanceId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp10tr8k9qasioaty****', 'title' => ''], 'WebUIStatus' => ['type' => 'string', 'example' => 'active', 'description' => '', 'title' => ''], 'WebUISnatStatus' => ['type' => 'string', 'example' => 'active', 'description' => '', 'title' => ''], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'title' => 'DescribeDBClusterAttribute', 'summary' => 'Retrieves details for a specific ApsaraDB for ClickHouse cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterAttribute'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterAttribute', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterConfig' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19440', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query the available region IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-wz988vja2mor4****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D'], 'Config' => ['description' => 'The parameter configuration of the cluster.', 'type' => 'string', 'title' => '', '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' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeDBClusterConfig', 'summary' => 'The DescribeDBClusterConfig operation queries the parameter configuration of a community-compatible ClickHouse cluster.', '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterConfigInXML' => [ 'summary' => 'You can call the DescribeDBClusterConfigInXML operation to query the configuration parameters of an ApsaraDB for ClickHouse Community-Compatible Edition cluster in XML format.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '153858', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'FE042911-2B00-134C-9F42-816871BBAFB8'], 'Config' => ['description' => 'The configuration parameters.', 'type' => 'string', 'title' => '', 'example' => ''."\n" .''."\n" .' 300'."\n" .' 64'."\n" .' '."\n" .' debug'."\n" .' 1000M'."\n" .' '."\n" .' 6871947673'."\n" .' 100'."\n" .' 4096'."\n" .' 0'."\n" .' 0'."\n" .'0.9'."\n" .' 0'."\n" .' 10000'."\n" .' '."\n" .' 256'."\n" .' 16 1'."\n" .' '."\n" .' 4194304'."\n" .'0'."\n" .' 3435973836'."\n" .''], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeDBClusterConfigInXML', 'description' => '> This operation supports only Community-Compatible Edition clusters that are created after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterConfigInXML', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE042911-2B00-134C-9F42-816871BBAFB8\\",\\n \\"Config\\": \\"\\\\n\\\\n 300\\\\n 64\\\\n \\\\n debug\\\\n 1000M\\\\n \\\\n 6871947673\\\\n 100\\\\n 4096\\\\n 0\\\\n 0\\\\n0.9\\\\n 0\\\\n 10000\\\\n \\\\n 256\\\\n 16 1\\\\n \\\\n 4194304\\\\n0\\\\n 3435973836\\\\n\\"\\n}","type":"json"}]', ], 'DescribeDBClusterNetInfoItems' => [ 'summary' => 'Queries the network information for a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1qx68m06981****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'NetInfoItems' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'NetInfoItem' => [ 'description' => 'A list of network information.', 'type' => 'array', 'items' => [ 'description' => 'A list of network information.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.'."\n" ."\n" .'> This parameter is empty if the network type of the endpoint is \\`Public\\`.', 'type' => 'string', 'title' => '', 'example' => 'vpc-bp175iuvg8nxqraf2****'], 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n" ."\n" .'> This parameter is empty if the network type of the endpoint is \\`Public\\`.', 'type' => 'string', 'title' => '', 'example' => 'vsw-bp1gzt31twhlo0sa5****'], 'ConnectionString' => ['description' => 'The database endpoint.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp1554t789i8e****.clickhouse.ads.aliyuncs.com'], 'JdbcPort' => ['description' => 'The Java Database Connectivity (JDBC) port number.', 'type' => 'string', 'title' => '', 'example' => '3306'], 'NetType' => ['description' => 'The network type of the endpoint. Valid values:'."\n" ."\n" .'- Public: the public network.'."\n" ."\n" .'- VPC: a VPC.', 'type' => 'string', 'title' => '', 'example' => 'VPC'], 'HttpPort' => ['description' => 'The HTTP port number.', 'type' => 'string', 'title' => '', 'example' => '8123'], 'IPAddress' => ['description' => 'The IP address.', 'type' => 'string', 'title' => '', 'example' => '10.255.234.251'], 'HttpsPort' => ['description' => 'The HTTPS port number.', 'type' => 'string', 'title' => '', 'example' => '8443'], 'MySQLPort' => ['description' => 'The MySQL port number.', 'type' => 'string', 'title' => '', 'example' => '9004'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ClusterNetworkType' => ['description' => 'The network type. Only VPC is supported.', 'type' => 'string', 'title' => '', 'example' => 'VPC'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9A23C87D-87DF-4DA0-A50E-CB13F4F7923D'], 'EnableSLB' => ['description' => 'Indicates whether Server Load Balancer (SLB) is enabled in the VPC. Valid values:'."\n" ."\n" .'- true: enabled.'."\n" ."\n" .'- false: disabled.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeDBClusterNetInfoItems', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusterNetInfoItems'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterNetInfoItems', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterNodeInfos' => [ 'methods' => ['get', 'post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '173004', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '746CD303-0B82-5E8D-886D-93A9FAF3A876'], 'NodeInfos' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ShardId' => ['description' => 'The shard ID.', 'type' => 'string', 'example' => '2', 'title' => ''], 'ReplicaId' => ['description' => 'The node ID.', 'type' => 'string', 'example' => '1', 'title' => ''], 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'ck-bp108z124a8****', 'title' => ''], 'NodeIp' => ['description' => 'The IP address of the node.', 'type' => 'string', 'example' => '172.168.0.1', 'title' => ''], 'FailoverTesting' => ['description' => 'Indicates whether a disaster recovery test is in progress.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => 'The node information.', 'title' => '', 'example' => '', ], 'description' => 'The information about the ClickHouse nodes.', 'title' => '', 'example' => '', ], 'ZkNodeInfos' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReplicaId' => ['description' => 'The ZooKeeper node ID.', 'type' => 'string', 'example' => '1', 'title' => ''], 'NodeName' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'ck-bp108z124a8****'."\n", 'title' => ''], 'FailoverTesting' => ['description' => 'Indicates whether a disaster recovery test is in progress.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'The information about the ZooKeeper nodes.', 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'TotalNodeCount' => ['description' => 'The total number of nodes.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeDBClusterNodeInfos', 'summary' => 'Queries node information for a ClickHouse Community-Compatible instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterNodeInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '19442', 'abilityTreeNodes' => ['FEATUREclickhouseLESIXD'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp125e3uu94wo****', 'title' => ''], ], [ 'name' => 'Key', 'in' => 'query', 'schema' => ['description' => 'The performance metrics that you want to query. Separate multiple metric names with a comma (,). You can query up to five performance metrics at a time. The following performance metrics are supported:'."\n" ."\n" .'> **Key** is required.'."\n" ."\n" .'- **CPU**:'."\n" ."\n" .' - **CPU\\_USAGE**: The CPU utilization.'."\n" ."\n" .'- **Memory**:'."\n" ."\n" .' - **MEM\\_USAGE**: The memory utilization.'."\n" ."\n" .' - **MEM\\_USAGE\\_SIZE**: The memory usage in MB.'."\n" ."\n" .'- **Disk**:'."\n" ."\n" .' - **DISK\\_USAGE**: The disk utilization.'."\n" ."\n" .' - **DISK\\_USAGE\\_SIZE**: The disk usage in MB.'."\n" ."\n" .' - **IOPS**: The disk input/output operations per second (IOPS).'."\n" ."\n" .'- **Connection**:'."\n" ."\n" .' - **CONN\\_USAGE**: The database connection utilization.'."\n" ."\n" .' - **CONN\\_USAGE\\_COUNT**: The number of database connections.'."\n" ."\n" .'- **Write**:'."\n" ."\n" .' - **TPS**: The number of rows written per second (TPS).'."\n" ."\n" .' - **INSERT\\_SIZE**: The write size per second in MB.'."\n" ."\n" .'- **Query**:'."\n" ."\n" .' - **QPS**: The queries per second (QPS).'."\n" ."\n" .' - **AVG\\_SEEK**: The number of random SEEK calls.'."\n" ."\n" .'- **WAIT**:'."\n" ."\n" .' - **ZK\\_WAIT**: The average wait time of ZooKeeper (ZK) in ms.'."\n" ."\n" .' - **IO\\_WAIT**: The average I/O wait time in ms.'."\n" ."\n" .' - **CPU\\_WAIT**: The average CPU wait time in ms.', 'type' => 'string', 'required' => false, 'example' => 'MEM_USAGE', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in UTC using the `yyyy-MM-ddTHH:mmZ` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-27T16:37Z', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in UTC using the `yyyy-MM-ddTHH:mmZ` format.'."\n" ."\n" .'> The end time must be later than the start time. The maximum time range cannot exceed 32 days.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-27T16:38Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'The end of the time range that was queried. The time is in UTC, formatted as `yyyy-MM-ddTHH:mmZ`.', 'type' => 'string', 'example' => '2021-11-27T16:38Z', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', 'title' => ''], 'StartTime' => ['description' => 'The beginning of the time range that was queried. The time is in UTC, formatted as `yyyy-MM-ddTHH:mmZ`.', 'type' => 'string', 'example' => '2021-11-27T16:37Z', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp125e3uu94wo****', 'title' => ''], 'Performances' => [ 'description' => 'The list of performance metrics for the cluster.', 'type' => 'array', 'items' => [ 'description' => 'The performance metric.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'MEM_USAGE', 'title' => ''], 'Unit' => ['description' => 'The unit of the metric.', 'type' => 'string', 'example' => '%', 'title' => ''], 'Series' => [ 'description' => 'The time series data for the metric.', 'type' => 'array', 'items' => [ 'description' => 'The metric information.', 'type' => 'object', 'properties' => [ 'Values' => [ 'description' => 'The values of the performance metrics, each associated with a sampling timestamp.', 'type' => 'array', 'items' => [ 'description' => 'The metric value.', 'type' => 'object', 'properties' => [ 'Point' => [ 'description' => 'The value of the performance metric.', 'type' => 'array', 'items' => ['description' => 'Detailed time-series data for the performance metric.', 'type' => 'string', 'example' => '[ "2021-11-26T16:39:00Z","15.08" ]', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the time series.', 'type' => 'string', 'example' => 'cc-bp125e3uu94wo1s0k16****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Name' => ['description' => 'The name of the performance metric.', 'type' => 'string', 'example' => 'mem_usage', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeDBClusterPerformance', 'summary' => 'Views the performance data of an ApsaraDB for ClickHouse Community-Compatible Edition cluster.', 'description' => 'You can view the performance monitoring data for a specified cluster within a time range based on performance metrics. The data is collected every 30 seconds.'."\n" ."\n" .'> This operation supports only ApsaraDB for ClickHouse Community-Compatible Edition clusters that were created before December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterPerformance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeDBClusterStatusSet' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19444', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DE309AA1-BD83-5E1F-9945-8A4D336E0829', 'title' => ''], 'StatusSet' => [ 'type' => 'array', 'items' => ['description' => 'The instance status.', 'type' => 'string', 'example' => 'ACTIVATION', 'title' => ''], 'description' => 'The set of instance statuses.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeDBClusterStatusSet', 'summary' => 'This operation queries the status set of a ClickHouse Community-Compatible Edition cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DE309AA1-BD83-5E1F-9945-8A4D336E0829\\",\\n \\"StatusSet\\": [\\n \\"ACTIVATION\\"\\n ]\\n}","type":"json"}]', ], 'DescribeDBClusters' => [ 'summary' => 'Describes ApsaraDB for ClickHouse clusters in a specified region.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '19443', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.'."\n" ."\n" .'> If you do not specify this parameter, information about all clusters is queried by default.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster description.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'DBClusterStatus', 'in' => 'query', 'schema' => ['description' => 'The state of the cluster. Valid values:'."\n" ."\n" .'- **Preparing**: The cluster is being prepared.'."\n" ."\n" .'- **Creating**: The cluster is being created.'."\n" ."\n" .'- **Running**: The cluster is running.'."\n" ."\n" .'- **Deleting**: The cluster is being deleted.'."\n" ."\n" .'- **SCALING\\_OUT**: The cluster is being scaled out.', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'description' => 'The tags.', 'type' => 'array', 'items' => [ 'description' => 'The tag.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'department', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'it', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'title' => '', 'example' => '', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group to which the cluster belongs.', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of entries returned per page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', 'title' => ''], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'DBClusters' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'DBCluster' => [ 'description' => 'The list of clusters.', 'type' => 'array', 'items' => [ 'description' => 'The list of clusters.', 'type' => 'object', 'properties' => [ 'VpcId' => ['description' => 'The VPC ID.', 'type' => 'string', 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''], 'DBNodeCount' => ['description' => 'The number of nodes.'."\n" ."\n" .'- For a single-replica edition cluster, the value is from 1 to 48.'."\n" ."\n" .'- For a dual-replica edition cluster, the value is from 1 to 24.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'CreateTime' => ['description' => 'The time when the cluster was created. The time is in the yyyy-MM-ddTHH:mm:ssZ format.', 'type' => 'string', 'example' => '2021-10-28T07:24:45Z', 'title' => ''], 'PayType' => ['description' => 'The billing method. Valid values:'."\n" ."\n" .'- **Postpaid**: pay-as-you-go.'."\n" ."\n" .'- **Prepaid**: subscription.', 'type' => 'string', 'example' => 'Postpaid', 'title' => ''], 'Tags' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Tag' => [ 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ 'description' => 'The tag.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'department', 'title' => ''], 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'it', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'StorageType' => ['description' => 'The storage class. Valid values:'."\n" ."\n" .''."\n" ."\n" .'- **CloudESSD\\_PL0**: ESSD PL0.'."\n" ."\n" .''."\n" ."\n\n" .'- **CloudESSD**: ESSD PL1.'."\n" ."\n" .'- **CloudESSD\\_PL2**: ESSD PL2.'."\n" ."\n" .'- **CloudESSD\\_PL3**: ESSD PL3.'."\n" ."\n" .'- **CloudEfficiency**: ultra disk.', 'type' => 'string', 'example' => 'CloudESSD', 'title' => ''], 'Port' => ['description' => 'The HTTP port.', 'type' => 'integer', 'format' => 'int32', 'example' => '8123', 'title' => ''], 'LockMode' => ['description' => 'The lock mode of the cluster. Valid values:'."\n" ."\n" .'- **Unlock**: The cluster is not locked.'."\n" ."\n" .'- **ManualLock**: The cluster is manually locked.'."\n" ."\n" .'- **LockByExpiration**: The cluster is automatically locked upon expiration.'."\n" ."\n" .'- **LockByRestoration**: The cluster is automatically locked before a rollback.'."\n" ."\n" .'- **LockByDiskQuota**: The cluster is automatically locked because the disk is full.', 'type' => 'string', 'example' => 'Unlock', 'title' => ''], 'Bid' => ['description' => 'The site ID. Valid values:'."\n" ."\n" .'- **26842**: Alibaba Cloud China Website (www\\.aliyun.com).'."\n" ."\n" .'- **26888**: Alibaba Cloud International Website (www\\.alibabacloud.com).', 'type' => 'string', 'example' => '26842', 'title' => ''], 'IsExpired' => ['description' => 'Indicates whether the cluster has expired. Valid values:'."\n" ."\n" .'- **true**: The cluster has expired.'."\n" ."\n" .'- **false**: The cluster has not expired.', 'type' => 'string', 'example' => 'false', 'title' => ''], 'VpcCloudInstanceId' => ['description' => 'The ID of the VPC instance.', 'type' => 'string', 'example' => 'vpc-bp175iuvg8nxqraf2****', 'title' => ''], 'ScaleOutStatus' => [ 'description' => 'The data migration status.', 'type' => 'object', 'properties' => [ 'Progress' => ['description' => 'The data migration progress in percentage.'."\n" ."\n" .'> This parameter is returned only when the cluster is in the SCALING\\_OUT state.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Ratio' => ['description' => 'The data migration progress. The format is \\`Data migrated/Total data\\`.'."\n" ."\n" .'> This parameter is returned only when the cluster is in the SCALING\\_OUT state.', 'type' => 'string', 'example' => '0MB/60469MB', 'title' => ''], ], 'title' => '', 'example' => '', ], 'ScaleOutDisableWriteWindows' => ['description' => 'The write-blocking window for the upgrade or downgrade.', 'type' => 'string', 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', 'title' => ''], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc-bp108z124a8o7****', 'title' => ''], 'ConnectionString' => ['description' => 'The VPC endpoint.', 'type' => 'string', 'example' => 'cc-bp1fs5o051c61****.clickhouse.ads.aliyuncs.com', 'title' => ''], 'CommodityCode' => ['description' => 'The commodity code.', 'type' => 'string', 'example' => 'clickhouse_go_public_cn', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the cluster. The time is in the yyyy-MM-ddTHH:mm:ssZ format.'."\n" ."\n" .'> Pay-as-you-go clusters do not expire. This parameter is empty for pay-as-you-go clusters.', 'type' => 'string', 'example' => '2011-05-30T12:11:4Z', 'title' => ''], 'DBNodeStorage' => ['description' => 'The storage space of a single node. The value ranges from 100 GB to 32,000 GB.'."\n" ."\n" .'> The step size is 100 GB.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'DBNodeClass' => ['description' => 'The instance type of the cluster.'."\n" ."\n" .'- For single-replica edition clusters, valid values are:'."\n" ."\n" .' - **LS20**: Large storage, 20 cores, 88 GB memory.'."\n" ."\n" .' - **LS40**: Large storage, 40 cores, 176 GB memory.'."\n" ."\n" .' - **LS80**: Large storage, 80 cores, 352 GB memory.'."\n" ."\n" .' - **S8**: Standard, 8 cores, 32 GB memory.'."\n" ."\n" .' - **S16**: Standard, 16 cores, 64 GB memory.'."\n" ."\n" .' - **S32**: Standard, 32 cores, 128 GB memory.'."\n" ."\n" .' - **S64**: Standard, 64 cores, 256 GB memory.'."\n" ."\n" .' - **S80**: Standard, 80 cores, 384 GB memory.'."\n" ."\n" .' - **S104**: Standard, 104 cores, 384 GB memory.'."\n" ."\n" .'- For dual-replica edition clusters, valid values are:'."\n" ."\n" .' - **LC20**: Large storage, 20 cores, 88 GB memory.'."\n" ."\n" .' - **LC40**: Large storage, 40 cores, 176 GB memory.'."\n" ."\n" .' - **LC80**: Large storage, 80 cores, 352 GB memory.'."\n" ."\n" .' - **C8**: Standard, 8 cores, 32 GB memory.'."\n" ."\n" .' - **C16**: Standard, 16 cores, 64 GB memory.'."\n" ."\n" .' - **C32**: Standard, 32 cores, 128 GB memory.'."\n" ."\n" .' - **C64**: Standard, 64 cores, 256 GB memory.'."\n" ."\n" .' - **C80**: Standard, 80 cores, 384 GB memory.'."\n" ."\n" .' - **C104**: Standard, 104 cores, 384 GB memory.'."\n" ."\n" .''."\n" ."\n" .'- For single-replica edition clusters, valid values are:'."\n" .' \\- **S4**: 4 cores, 16 GB memory.'."\n" .' \\- **S8**: 8 cores, 32 GB memory.'."\n" ."\n" .' - **S16**: 16 cores, 64 GB memory.'."\n" ."\n" .' - **S32**: 32 cores, 128 GB memory.'."\n" ."\n" .' - **S64** : 64 cores, 256 GB memory.'."\n" ."\n" .' - **S104**: 104 cores, 384 GB memory.'."\n" ."\n" .'- For dual-replica edition clusters, valid values are:'."\n" .' \\- **C4**: 4 cores, 16 GB memory.'."\n" .' \\- **C8**: 8 cores, 32 GB memory.'."\n" .' \\- **C16**: 16 cores, 64 GB memory.'."\n" .' \\- **C32**: 32 cores, 128 GB memory.'."\n" .' \\- **C64** : 64 cores, 256 GB memory.'."\n" .' \\- **C104**: 104 cores, 384 GB memory.'."\n" ."\n" .'', 'type' => 'string', 'example' => 'C8', 'title' => ''], 'AliUid' => ['description' => 'The Alibaba Cloud account ID.', 'type' => 'string', 'example' => '140692647406****', 'title' => ''], 'LockReason' => ['description' => 'The reason why the cluster was locked.'."\n" ."\n" .'> This parameter is empty if the cluster is not locked.', 'type' => 'string', 'example' => 'DISK_FULL', 'title' => ''], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], 'VSwitchId' => ['description' => 'The vSwitch ID.', 'type' => 'string', 'example' => 'vsw-bp1gzt31twhlo0sa5****', 'title' => ''], 'DBClusterStatus' => ['description' => 'The state of the cluster. Valid values:'."\n" ."\n" .'- **Preparing**: The cluster is being prepared.'."\n" ."\n" .'- **Creating**: The cluster is being created.'."\n" ."\n" .'- **Running**: The cluster is running.'."\n" ."\n" .'- **Deleting**: The cluster is being deleted.'."\n" ."\n" .'- **SCALING\\_OUT**: The cluster is being scaled out.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'DBClusterDescription' => ['description' => 'The cluster description.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'DBClusterNetworkType' => ['description' => 'The network type. Only VPC is supported.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'example' => 'cn-hangzhou-h', 'title' => ''], 'Category' => ['description' => 'The edition of the cluster. Valid values:'."\n" ."\n" .'- **Basic**: Single-replica Edition.'."\n" ."\n" .'- **HighAvailability**: Dual-replica Edition.', 'type' => 'string', 'example' => 'Basic', 'title' => ''], 'ControlVersion' => ['description' => 'The version of the backend management system. Valid values:'."\n" ."\n" .'- **v1**'."\n" ."\n" .'- **v2**', 'type' => 'string', 'example' => 'v1', 'title' => ''], 'ExtStorageType' => ['description' => 'The extended storage class. Valid values:'."\n" ."\n" .'- **CloudSSD**: standard SSD.'."\n" ."\n" .'- **CloudESSD**: ESSD PL1.'."\n" ."\n" .'- **CloudESSD\\_PL2**: ESSD PL2.'."\n" ."\n" .'- **CloudESSD\\_PL3**: ESSD PL3.'."\n" ."\n" .'- **CloudEfficiency**: ultra disk.', 'type' => 'string', 'example' => 'CloudESSD', 'title' => ''], 'ExtStorageSize' => ['description' => 'The extended storage space.', 'type' => 'integer', 'format' => 'int32', 'example' => '100GB', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the cluster belongs.', 'type' => 'string', 'example' => 'rg-4690g37929****', 'title' => ''], 'DbVersion' => ['description' => 'The kernel version of the cluster.', 'type' => 'string', 'example' => '23.8', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'Forbidden', 'errorMessage' => 'User not authorized to operate on the specified resource.', 'description' => 'The account is not granted permission to manipulate the resource'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeDBClusters', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '2500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeDBClusters'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusters', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'DescribeDBConfig' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19445', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-t4nw17nh2e4t2****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '16060117-92E1-5F3B-BF42-28B172D0F869'], 'Config' => ['description' => 'The cluster configuration.', 'type' => 'string', 'title' => '', 'example' => 'test10.37.XX.XX9000defaultdefaultt_organizationid=1SQL_QUERY3133field1String'], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeDBConfig', 'summary' => 'The DescribeDBConfig operation queries the configuration of a community-compatible cluster.', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16060117-92E1-5F3B-BF42-28B172D0F869\\",\\n \\"Config\\": \\"test10.37.XX.XX9000defaultdefaultt_organizationid=1SQL_QUERY3133field1String\\"\\n}","type":"json"}]', ], 'DescribeEventMetaInfo' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201222', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'SourceCode', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['description' => 'The codes of O\\&M event types. Separate multiple codes with commas.', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => 'Event.EventCode', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', 'title' => ''], 'Items' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The code of the O\\&M task.', 'type' => 'string', 'example' => 'Running', 'title' => ''], 'SourceCode' => ['description' => 'The type of the O\\&M task.', 'type' => 'string', 'example' => 'Task.TaskStatus', 'title' => ''], ], 'description' => 'The metadata of the O\\&M task.', 'title' => '', 'example' => '', ], 'description' => 'The metadata of O\\&M tasks.', 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeEventMetaInfo', 'summary' => 'Queries the metadata of Operations and Maintenance (O&M) events for a ClickHouse-compatible cluster.', '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' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19453', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Policy' => ['description' => 'The parameters of the tiered storage policy for hot and cold data.', 'type' => 'string', 'title' => '', 'example' => '[{ "currentValue":"0.1", "defaultValue":"0.1", "desc":"Ratio of free disk space. When the ratio exceeds the value of configuration parameter, ClickHouse start to move data to the cold storage", "name":"move_factor", "restart":true, "valueRange":"(0, 1]" },{ "currentValue":"true", "defaultValue":"true", "desc":"Disables merging of data parts on cold storage", "name":"prefer_not_to_merge", "restart":true, "valueRange":"true|false" }]'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'aadbb456-ebf7-4ed8-9671-fad9f3846ca4'], 'State' => ['description' => 'The status of tiered storage for hot and cold data. Valid values:'."\n" ."\n" .'- **CREATING**: Tiered storage is being enabled.'."\n" ."\n" .'- **DISABLE**: Tiered storage is disabled.'."\n" ."\n" .'- **ENABLE**: Tiered storage is enabled.', 'type' => 'string', 'title' => '', 'example' => 'ENABLE'], 'ColdStorage' => ['description' => 'Indicates whether tiered storage for hot and cold data can be enabled. Valid values:'."\n" ."\n" .'- **true**: Tiered storage can be enabled.'."\n" ."\n" .'- **false**: Tiered storage cannot be enabled.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'StorageUsage' => ['description' => 'The cold storage space used. Unit: GB.', 'type' => 'string', 'title' => '', 'example' => '0.00'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeOSSStorage', 'summary' => 'Queries cold storage information.', '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeProcessList' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19454', 'abilityTreeNodes' => ['FEATUREclickhouseLESIXD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to find the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. You can call the [DescribeDBClusters](~~170879~~) operation to find information about all clusters in the destination region, including the cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1190tj036am****'], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', 'schema' => ['description' => 'The shortest query duration. The minimum value is **1000**. The default value is **1000**. The unit is milliseconds. The response returns queries that run longer than this duration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '9999999999', 'minimum' => '0', 'isFileTransferUrl' => false, 'title' => '', 'example' => '500'], ], [ 'name' => 'InitialUser', 'in' => 'query', 'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'user'], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The keyword for the query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'join'], ], [ 'name' => 'Order', 'in' => 'query', 'schema' => ['description' => 'The column to use for sorting. Valid values:'."\n" ."\n" .'- elapsed: The total running time.'."\n" ."\n" .'- written\\_rows: The number of rows written.'."\n" ."\n" .'- read\\_rows: The number of rows read.'."\n" ."\n" .'- memory\\_usage: The amount of memory used.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'elapsed'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'isFileTransferUrl' => false, 'default' => '30', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be greater than 0 and cannot exceed the maximum value of the Integer data type. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '1', 'isFileTransferUrl' => false, 'default' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'InitialQueryId', 'in' => 'query', 'schema' => ['description' => 'The ID of the query.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '6c69d508-f05f-4c74-857c-d982b7e7e79f'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'FD61BB0D-788A-5185-A8E3-1B90BA8F6F04'], 'ProcessList' => [ 'description' => 'The list of tasks.', 'type' => 'object', 'properties' => [ 'TableSchema' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResultSet' => [ 'description' => 'The details of the columns.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type of the column.', 'type' => 'string', 'title' => '', 'example' => 'String'], 'Name' => ['description' => 'The name of the column.', 'type' => 'string', 'title' => '', 'example' => 'InitialUser'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResultSet' => [ 'description' => 'The details of the tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'QueryStartTime' => ['description' => 'The time when the query started. The time is in the yyyy-MM-ddTHH:mm:ssZ format and is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2021-02-02T09:14:48Z'], 'Query' => ['description' => 'The query statement.', 'type' => 'string', 'title' => '', 'example' => 'select * from test order by score limit 1;'], 'InitialAddress' => ['description' => 'The IP address of the client that initiated the query.', 'type' => 'string', 'title' => '', 'example' => '::ffff:10.1.XX.XX'], 'InitialQueryId' => ['description' => 'The query ID.', 'type' => 'string', 'title' => '', 'example' => '2dd144fd-4230-4249-b15c-e63f964fbb5a'], 'InitialUser' => ['description' => 'The database account.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'QueryDurationMs' => ['description' => 'The query duration in milliseconds.', 'type' => 'string', 'title' => '', 'example' => '2000'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Rows' => ['description' => 'The number of rows returned for the query.', 'type' => 'string', 'title' => '', 'example' => '1145700'], 'RowsBeforeLimitAtLeast' => ['description' => 'The page size in rows.', 'type' => 'string', 'title' => '', 'example' => '1'], 'Statistics' => [ 'description' => 'The statistics of the query result.', 'type' => 'object', 'properties' => [ 'RowsRead' => ['description' => 'The number of rows scanned.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1000000'], 'ElapsedTime' => ['description' => 'The elapsed time.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '4156'], 'BytesRead' => ['description' => 'The size of the scanned data, in bytes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '9141300000'], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeProcessList', 'summary' => 'Call the DescribeProcessList operation to retrieve running queries on an ApsaraDB for ClickHouse Community-Compatible cluster.', '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' => 'Queries the available regions and zones for ApsaraDB for ClickHouse.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19455', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], 'Regions' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Region' => [ 'description' => 'A list of regions.', 'type' => 'array', 'items' => [ 'description' => 'The region.', 'type' => 'object', 'properties' => [ 'Zones' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Zone' => [ 'description' => 'A list of zones.', 'type' => 'array', 'items' => [ 'description' => 'The zone.', 'type' => 'object', 'properties' => [ 'ZoneId' => ['description' => 'The zone ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou-h'], 'VpcEnabled' => ['description' => 'Indicates whether VPC is supported. Valid values:'."\n" ."\n" .'- **true**: Supported.'."\n" ."\n" .'- **false**: Not supported.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'DescribeRegions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeRegions'], ], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeSchemas' => [ 'summary' => 'Queries all databases in an instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19456', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Schema' => [ 'description' => 'The database information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeSchemas', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeSchemas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Items\\": {\\n \\"Schema\\": [\\n {\\n \\"DBClusterId\\": \\"cc-bp108z124a8o7****\\",\\n \\"SchemaName\\": \\"database\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'DescribeSlowLogRecords' => [ 'summary' => 'Queries the details of slow query logs.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19457', 'abilityTreeNodes' => ['FEATUREclickhouseLESIXD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1z58t881wcx****'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. The format is \\`yyyy-MM-dd hh:mm:ss\\`. The time is in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2022-05-20 16:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. The format is \\`yyyy-MM-dd hh:mm:ss\\`. The time is in UTC.'."\n" ."\n" .'> The end time must be later than the start time. The interval between the start time and the end time cannot exceed 7 days.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2022-05-27 16:00:00'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99999999', 'minimum' => '1', 'isFileTransferUrl' => false, 'default' => '30', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number. The value must be an integer that is greater than 0 and does not exceed the maximum value of the Integer data type. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99999999', 'minimum' => '1', 'isFileTransferUrl' => false, 'default' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', 'schema' => ['description' => 'The minimum query duration, in milliseconds. The minimum value is **1000**. The default value is **1000**. The response returns information about queries that take longer than the specified duration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'isFileTransferUrl' => false, 'default' => '1000', 'title' => '', 'example' => '1000'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A'], 'SlowLogRecords' => [ 'description' => 'The details of the slow query logs.', 'type' => 'object', 'properties' => [ 'TableSchema' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResultSet' => [ 'description' => 'The structure of the database table.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The column type.', 'type' => 'string', 'title' => '', 'example' => 'String'], 'Name' => ['description' => 'The column name.', 'type' => 'string', 'title' => '', 'example' => 'name'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResultSet' => [ 'description' => 'The list of slow query log entries.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The query status. Valid values:'."\n" ."\n" .'- **QueryFinish**: The query is complete.'."\n" ."\n" .'- **Processing**: The query is running.', 'type' => 'string', 'title' => '', 'example' => 'QueryFinish'], 'QueryStartTime' => ['description' => 'The start time of the query. The format is \\`yyyy-MM-dd hh:mm:ss\\`. The time is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-22 20:00:01'], 'Query' => ['description' => 'The query statement.', 'type' => 'string', 'title' => '', 'example' => 'Select * from table'], 'ReadRows' => ['description' => 'The number of rows read for the query.', 'type' => 'string', 'title' => '', 'example' => '10027008'], 'InitialAddress' => ['description' => 'The IP address of the client that initiated the query.', 'type' => 'string', 'title' => '', 'example' => '::ffff:100.104.XX.XX'], 'MemoryUsage' => ['description' => 'The peak memory usage for the query, in bytes.', 'type' => 'string', 'title' => '', 'example' => '1048576'], 'InitialUser' => ['description' => 'The username that was used to initiate the query.', 'type' => 'string', 'title' => '', 'example' => 'test_users'], 'InitialQueryId' => ['description' => 'The query ID.', 'type' => 'string', 'title' => '', 'example' => '\'b51496f2-6b0b-4546-aff9-e17951cb9410\''], 'ReadBytes' => ['description' => 'The amount of data read for the query, in bytes.', 'type' => 'string', 'title' => '', 'example' => '1048576'], 'QueryDurationMs' => ['description' => 'The time consumed by the query, in milliseconds.', 'type' => 'string', 'title' => '', 'example' => '2000'], 'ResultBytes' => ['description' => 'The size of the result data, in bytes.', 'type' => 'string', 'title' => '', 'example' => '1024'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Rows' => ['description' => 'The number of rows in the result set.', 'type' => 'string', 'title' => '', 'example' => '1'], 'RowsBeforeLimitAtLeast' => ['description' => 'The number of entries on each page.', 'type' => 'string', 'title' => '', 'example' => '1'], 'Statistics' => [ 'description' => 'The statistics of the query results.', 'type' => 'object', 'properties' => [ 'RowsRead' => ['description' => 'The number of rows read.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '2016722'], 'ElapsedTime' => ['description' => 'The time elapsed for the slow query, in milliseconds.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '21.35'], 'BytesRead' => ['description' => 'The amount of data read, in bytes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '123456'], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeSlowLogRecords', '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeSlowLogTrend' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19458', 'abilityTreeNodes' => ['FEATUREclickhouseLESIXD'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in a specific region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp11xxl475ui8****'], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the \\`yyyy-MM-dd hh:mm:ss\\` format. The time is in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2022-05-20 16:00:00'], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end of the time range to query. Specify the time in the \\`yyyy-MM-dd hh:mm:ss\\` format. The time is in UTC.'."\n" ."\n" .'> The end time must be later than the start time. The time range cannot exceed 7 days.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '2022-05-27 16:00:00'], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', 'schema' => ['description' => 'The execution duration of a slow SQL query, in milliseconds. The minimum value is **1000**. The default value is **1000**. The operation returns slow SQL queries that take longer than this duration to execute.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9999999999', 'minimum' => '0', 'isFileTransferUrl' => false, 'default' => '1000', 'title' => '', 'example' => '1000'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF'], 'SlowLogTrend' => [ 'description' => 'The result set of the slow SQL queries.', 'type' => 'object', 'properties' => [ 'TableSchema' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResultSet' => [ 'description' => 'The table schema.', 'type' => 'array', 'items' => [ 'description' => 'The schema of the result table.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The column type.', 'type' => 'string', 'title' => '', 'example' => 'UInt64'], 'Name' => ['description' => 'The column name.', 'type' => 'string', 'title' => '', 'example' => 'query_start_time'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Data' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'ResultSet' => [ 'description' => 'The list of slow SQL queries.', 'type' => 'array', 'items' => [ 'description' => 'The list of slow SQL queries.', 'type' => 'object', 'properties' => [ 'QueryStartTime' => ['description' => 'The start time of the query. The time is in the \\`yyyy-MM-dd hh:mm:ss\\` format. The time is in UTC.', 'type' => 'string', 'title' => '', 'example' => '2022-05-22 20:00:01'], 'MaxQueryDurationMs' => ['description' => 'The longest execution duration. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '3000'], 'MinQueryDurationMs' => ['description' => 'The shortest execution duration. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '1000'], 'Count' => ['description' => 'The total execution duration of slow SQL queries. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '4000'], 'AvgQueryDurationMs' => ['description' => 'The average execution duration. Unit: milliseconds.', 'type' => 'string', 'title' => '', 'example' => '2000'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'Rows' => ['description' => 'The number of rows in the result set.', 'type' => 'string', 'title' => '', 'example' => '1'], 'RowsBeforeLimitAtLeast' => ['description' => 'The minimum number of rows that are returned before the \\`LIMIT\\` clause is applied.', 'type' => 'string', 'title' => '', 'example' => '1'], 'Statistics' => [ 'description' => 'The statistics of the query results.', 'type' => 'object', 'properties' => [ 'RowsRead' => ['description' => 'The number of rows read.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '14721'], 'ElapsedTime' => ['description' => 'The query execution duration. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '0.001703578'], 'BytesRead' => ['description' => 'The amount of data read. Unit: bytes.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '697899'], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeSlowLogTrend', 'summary' => 'Queries statistics about the slow log trends for a cluster.', '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeSynDbTables' => [ 'summary' => 'Queries synchronized databases and tables.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '46614', 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ 'name' => 'DbClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp158i5wvj436****'], ], [ 'name' => 'SynDb', 'in' => 'query', 'schema' => ['description' => 'The name of the ApsaraDB RDS for MySQL database.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'database'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '851D11EA-681C-5B38-A065-C3F90BBD49DE'], 'Tables' => [ 'description' => 'The tables.', 'type' => 'array', 'items' => ['description' => 'The name of an ApsaraDB RDS for MySQL table.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeSynDbTables', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSynDbTables'], ], ], '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"851D11EA-681C-5B38-A065-C3F90BBD49DE\\",\\n \\"Tables\\": [\\n \\"test\\"\\n ]\\n}","type":"json"}]', ], 'DescribeSynDbs' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '44312', 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ 'name' => 'DbClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1ab22b80814****'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of records to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '20', 'title' => '', 'example' => '20'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'title' => '', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7655F5F9-1313-5ABA-8516-F6EB79605A5F'], 'SynDbs' => [ 'description' => 'The synchronized data.', 'type' => 'array', 'items' => [ 'description' => 'The objects synchronized to ClickHouse.', 'type' => 'object', 'properties' => [ 'RdsId' => ['description' => 'The instance ID of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'title' => '', 'example' => 'rm-wz9d11qg1j0h4****'], 'SynDb' => ['description' => 'The database in the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'title' => '', 'example' => 'database'], 'SynStatus' => ['description' => 'Indicates whether the synchronization was successful. Valid values:'."\n" ."\n" .'- **true**: The synchronization was successful.'."\n" ."\n" .'- **false**: The synchronization failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'ErrorMsg' => ['description' => '- This parameter is not returned if **SynStatus** is **true**.'."\n" ."\n" .'- If **SynStatus** is **false**, this parameter indicates the reason for the synchronization failure.', 'type' => 'string', 'title' => '', 'example' => 'ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n'], 'RdsUserName' => ['description' => 'The database account for the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'RdsVpcUrl' => ['description' => 'The internal endpoint of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'title' => '', 'example' => 'rm-bp16t9h3999xb0a711****.mysql.rds.aliyuncs.com:3306'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '0'], 'PageSize' => ['description' => 'The number of records on each page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeSynDbs', 'summary' => 'Queries information about synchronized databases.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DescribeSynDbs'], ], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeTables' => [ 'summary' => 'You can call the DescribeTables operation to query tables in a community-compatible cluster.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '19459', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'SchemaName', 'in' => 'query', 'schema' => ['description' => 'The database name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'database'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], 'Items' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'Table' => [ 'description' => 'The table information.', 'type' => 'array', 'items' => [ 'description' => 'A table.', 'type' => 'object', 'properties' => [ 'TableName' => ['description' => 'The table name.', 'type' => 'string', 'title' => '', 'example' => 'test'], 'DBClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp108z124a8o7****'], 'SchemaName' => ['description' => 'The database name.', 'type' => 'string', 'title' => '', 'example' => 'database'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeTables', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeTables', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'DescribeTransferHistory' => [ 'summary' => 'View migration history.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '36715', 'abilityTreeNodes' => ['FEATUREclickhouseMCDGZK'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'HistoryDetails' => [ 'type' => 'object', 'itemNode' => true, 'properties' => [ 'HistoryDetail' => [ 'description' => 'Details of the data migration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SourceDBCluster' => ['description' => 'The source cluster ID.', 'type' => 'string', 'example' => 'cc-bp108z124a8o7****', 'title' => ''], 'SourceControlVersion' => ['description' => 'The control version of the source cluster.', 'type' => 'string', 'example' => 'v1', 'title' => ''], 'TargetDBCluster' => ['description' => 'The target cluster ID.', 'type' => 'string', 'example' => 'cc-bp13zkh9uw523****', 'title' => ''], 'TargetControlVersion' => ['description' => 'The control version of the target cluster.', 'type' => 'string', 'example' => 'v2', 'title' => ''], 'Status' => ['description' => 'The data migration status. Valid values:'."\n" ."\n" .'- **Finished**: Completed.'."\n" ."\n" .'- **Processing**: In progress.', 'type' => 'string', 'example' => 'Finished', 'title' => ''], 'Progress' => ['description' => 'The data migration progress.', 'type' => 'string', 'example' => '100%', 'title' => ''], 'DisableWriteWindows' => ['description' => 'The write suspension window.', 'type' => 'string', 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00', 'title' => ''], 'UnsyncedBytes' => ['description' => 'The amount of unsynchronized data, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '102400', 'title' => ''], 'UnsyncedParts' => ['description' => 'The number of unsynchronized parts.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], 'PartsPerMinute' => ['description' => 'The number of parts migrated per minute.', 'type' => 'number', 'format' => 'double', 'example' => '1.24', 'title' => ''], 'BytesPerMinute' => ['description' => 'The amount of data migrated per minute, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10240', 'title' => ''], 'SubJob' => ['description' => 'The active sub-job.', 'type' => 'string', 'example' => 'SubJob', 'title' => ''], 'SubJobStatus' => ['description' => 'The status of the sub-job.', 'type' => 'string', 'example' => 'running', 'title' => ''], 'SubJobMessage' => ['description' => 'The message returned by the sub-job.', '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)', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'DescribeTransferHistory', 'description' => '> This API operation is used only to query data migrations between Alibaba Cloud ClickHouse clusters during version upgrades.', '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' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '220406', 'abilityTreeNodes' => ['FEATUREclickhouseY04H6E'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', 'title' => ''], 'KmsKeys' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'KeyId' => ['description' => 'The key ID.', 'type' => 'string', 'example' => '0275bd3f-fdbb-4d8c-846b-71b211******'."\n", 'title' => ''], ], 'description' => 'The list of KMS keys.', 'title' => '', 'example' => '', ], 'description' => 'The list of KMS keys.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DescribeUserEncryptionKeyList', 'summary' => 'Retrieves a list of your KMS keys.', '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' => 'Switches the ZooKeeper leader for a community-compatible ClickHouse instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '173004', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'DisableWrite', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to disable writes.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ElectTime', 'in' => 'query', 'schema' => ['description' => 'The time to perform the leader switchover.', 'type' => 'string', 'required' => false, 'example' => '2025-12-12T07:28:00Z', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF'], ], 'title' => '', 'description' => 'Response information.', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ElectZookeeperLeader', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\"\\n}","type":"json"}]', ], 'KillProcess' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19460', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'InitialQueryId', 'in' => 'query', 'schema' => ['description' => 'The search statement to stop. To stop multiple statements, separate them with commas (,).'."\n" ."\n" .'> If you do not specify this parameter, all search statements are stopped by default.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'SELECT * FROM `test01` ;'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'KillProcess', 'summary' => 'Stops ongoing tasks.', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","type":"json"}]', ], 'ListTagResources' => [ 'summary' => 'Lists the tags that are attached to ApsaraDB for ClickHouse clusters.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'abilityTreeCode' => '166149', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> You can call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Set the value to **DBCLUSTER**.', 'type' => 'string', 'required' => true, 'example' => 'DBCLUSTER', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first query. If a query does not return all results, a NextToken value is returned. You can use this token in a subsequent query to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => '212db86sca4384811e0b5e8707ec21345', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => ''."\n" ."\n" .'The cluster ID. You can specify from **1** to **50** cluster IDs.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'The ID of the cluster. You can specify N cluster IDs. The value of N is an integer from **1 to 50**.'."\n" ."\n" .''."\n" ."\n" .'> - You can call the [DescribeDBClusters](~~170879~~) operation to query the information about all clusters in a region, including cluster IDs.'."\n" ."\n" .'- If you specify the **Tag.N.Key** parameter, you can leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp1t9lbb7a4z7****', 'title' => ''], 'required' => false, 'maxItems' => 51, 'description' => 'The resource ID.', 'title' => '', 'example' => '', ], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key. You can specify from 1 to **20** tag keys.'."\n" ."\n" .'> If you specify the **ResourceId.N** parameter, you can leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => 'testkey1', 'title' => ''], 'Value' => ['description' => 'The value of the tag. You can specify from 1 to **20** tag values.'."\n" ."\n" .'> You can leave this parameter empty.', 'type' => 'string', 'required' => false, 'example' => 'testvalue1', 'title' => ''], ], 'required' => false, 'description' => 'The list of tags.', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 21, 'description' => 'The list of tags.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '184DE106-CB2C-4DD2-B57F-396652E6C8F8'], 'NextToken' => ['description' => 'The token that is used to retrieve the next page of results. This parameter is returned only if the results are not fully returned in the current request. You can use this token in a subsequent request to retrieve the next page of results.', 'type' => 'string', 'example' => '212db86sca4384811e0b5e8707ec21345', 'title' => ''], 'TagResources' => [ 'description' => 'Information about the clusters and their tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TagValue' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'testvalue1', 'title' => ''], 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'testkey1', 'title' => ''], 'ResourceType' => ['description' => 'The resource type. The value is **DBCLUSTER**.', 'type' => 'string', 'example' => 'DBCLUSTER', 'title' => ''], 'ResourceId' => ['description' => ''."\n" ."\n" .'The cluster ID.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'', 'type' => 'string', 'example' => 'cc-bp1t9lbb7a4z7****', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ListTagResources', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', ], 'ModifyAccountAuthority' => [ 'summary' => 'Modifies the permissions of a database account.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19461', 'abilityTreeNodes' => ['FEATUREclickhouseL1079N'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the most recent region list.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'DmlAuthority', 'in' => 'query', 'schema' => ['description' => 'The DML permissions granted to the database account. Valid values:'."\n" ."\n" .'- **all**: Grants read, write, and modify permissions.'."\n" ."\n" .'- **readonly,modify**: Grants read and modify permissions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'all', 'title' => ''], ], [ 'name' => 'DdlAuthority', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to grant DDL permissions to the database account. Valid values:'."\n" ."\n" .'- **true**: Allows DDL operations.'."\n" ."\n" .'- **false**: Denies DDL operations.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'AllowDatabases', 'in' => 'query', 'schema' => ['description' => 'The list of databases to authorize. Separate multiple database names with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'db1', 'title' => ''], ], [ 'name' => 'TotalDatabases', 'in' => 'query', 'schema' => ['description' => 'All databases in the cluster. Separate multiple database names with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'db1,db2', 'title' => ''], ], [ 'name' => 'AllowDictionaries', 'in' => 'query', 'schema' => ['description' => 'The list of dictionaries to authorize. Separate multiple dictionary names with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'dt1', 'title' => ''], ], [ 'name' => 'TotalDictionaries', 'in' => 'query', 'schema' => ['description' => 'All dictionaries in the cluster. Separate multiple dictionary names with commas (,).', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dt1,dt2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","type":"json"}]', 'title' => 'ModifyAccountAuthority', 'description' => 'This API operation applies only to cluster versions 21.8 and earlier. For cluster versions later than 21.8, you must use a high-privilege account to run SQL statements to modify the permissions of standard users.', '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' => 'Modifies the description of a database account in an ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19462', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], ], [ 'name' => 'AccountDescription', 'in' => 'query', 'schema' => ['description' => 'The new description of the database account.'."\n" ."\n" .'- The description cannot start with http\\:// or https\\://.'."\n" ."\n" .'- The description must be 0 to 256 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'ceshi'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyAccountDescription', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyAccountDescription'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyAccountDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', ], 'ModifyActiveOperationMaintainConf' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'systemTags' => ['operationType' => 'none', 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'CycleType', 'in' => 'query', 'schema' => ['description' => 'The recurrence cycle. Valid values:'."\n" ."\n" .'- Month: monthly'."\n" ."\n" .'- Week: weekly', 'type' => 'string', 'required' => false, 'example' => 'Week', 'title' => ''], ], [ 'name' => 'CycleTime', 'in' => 'query', 'schema' => ['description' => 'The day of the recurrence cycle.'."\n" ."\n" .'- If CycleType is set to Month, this parameter specifies the day of the month. Valid values are 1 to 28. Use a comma (,) to separate multiple days.'."\n" ."\n" .'- If CycleType is set to Week, this parameter specifies the day of the week. Valid values are 1 to 7. Use a comma (,) to separate multiple days.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'MaintainStartTime', 'in' => 'query', 'schema' => ['description' => 'The start time of the maintenance window. Use the HH:mmZ format. The time is in UTC.', 'type' => 'string', 'required' => false, 'example' => '07:00Z', 'title' => ''], ], [ 'name' => 'MaintainEndTime', 'in' => 'query', 'schema' => ['description' => 'The end time of the maintenance window. Use the HH:mmZ format. The time is in UTC.', 'type' => 'string', 'required' => false, 'example' => '20:00Z', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether the configuration is enabled. Valid values:'."\n" ."\n" .'- **1**: Enabled.'."\n" ."\n" .'- **2**: Disabled.', 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'enum' => ['1', '2'], 'example' => '1', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyActiveOperationMaintainConf', 'summary' => 'Modifies the configuration of active O&M tasks on a community-compatible ClickHouse cluster.', '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' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '201218', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'Ids', 'in' => 'query', 'schema' => ['description' => 'The O\\&M task IDs. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '188****,188****,188****', 'title' => ''], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => ['description' => 'The time to initiate the switch operation. The time is in UTC and the format is YYYY-MM-DDTHH:mm:ssZ.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2023-01-09T05:00:00Z', 'title' => ''], ], [ 'name' => 'ImmediateStart', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to immediately execute the O\\&M task. Valid values:'."\n" ."\n" .'- **1**: Execute immediately.'."\n" ."\n" .'- **0**: Execute at the specified time.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Ids' => ['description' => 'The O\\&M event IDs. Multiple IDs are separated by commas (,).', 'type' => 'string', 'example' => '188****,188****,188****', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '617242AA-04D8-5AF0-8C0C-6E53DDA8C3C3', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyActiveOperationTasks', 'summary' => 'Modifies the switch time for operations and maintenance (O&M) events on a ClickHouse Community-compatible cluster.', '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' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'DBClusterIds', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The cluster ID. To specify multiple cluster IDs, separate them with commas (,).', 'title' => '', 'example' => 'cc-bp1uy5ff6*****'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'description' => 'The region ID.', 'title' => '', 'example' => 'cn-beijing'], ], [ 'name' => 'RenewalStatus', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'default' => 'AutoRenewal', 'description' => 'The renewal method. Valid values:'."\n" ."\n" .'- **AutoRenewal**: Auto-renewal.'."\n" ."\n" .'- **Normal**: Manual renewal.'."\n" ."\n" .'- **NotRenewal**: The cluster is not renewed after it expires.', 'title' => '', 'example' => 'AutoRenewal'], ], [ 'name' => 'Duration', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'default' => '1', 'description' => 'The renewal duration. The default value is **1**.'."\n" ."\n" .'- If you set \\`PeriodUnit\\` to **Month**, valid values are integers from 1 to 11.'."\n" ."\n" .'- If you set \\`PeriodUnit\\` to **Year**, valid values are 1, 2, 3, and 5.'."\n" ."\n" .'> A longer subscription period offers a better price. For example, a one-year subscription is more cost-effective than a 10-month or 11-month subscription.', 'title' => '', 'example' => '1'], ], [ 'name' => 'PeriodUnit', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'default' => 'Month', 'description' => 'The unit of the renewal duration specified by the \\`Duration\\` parameter. Valid values: Month and Year.', 'title' => '', 'example' => 'Year'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => 'The request ID.', 'title' => '', 'example' => '7B94AB34-6875-56D2-92B4-0C2******'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ModifyAutoRenewAttribute', 'summary' => 'Modifies the auto-renewal status of a ClickHouse Community-Compatible cluster.', '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' => 'Modifies the backup settings of a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19463', 'abilityTreeNodes' => ['FEATUREclickhouseYFBZ0B'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1qx68m06981****'], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => ['description' => 'The backup time in UTC. The format is HH:mmZ-HH:mmZ.'."\n" ."\n" .'Example: 00:00Z-01:00Z. This means that data backup can be performed from 00:00 to 01:00 UTC. This corresponds to 08:00 to 09:00 UTC+8.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '15:00Z-16:00Z'], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => ['description' => 'The backup cycle. If you specify multiple values, separate them with commas. Valid values:'."\n" ."\n" .'- **Monday**'."\n" ."\n" .'- **Tuesday**'."\n" ."\n" .'- **Wednesday**'."\n" ."\n" .'- **Thursday**'."\n" ."\n" .'- **Friday**'."\n" ."\n" .'- **Saturday**'."\n" ."\n" .'- **Sunday**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'Monday'], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => ['description' => 'The number of days to retain data backups. Valid values: 7 to 730.', 'type' => 'string', 'required' => false, 'default' => '7', 'title' => '', 'example' => '7'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyBackupPolicy', 'description' => '> Data backup is supported for ApsaraDB for ClickHouse clusters that run version 20.3, 20.8, or 21.8.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyBackupPolicy'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', ], 'ModifyDBCluster' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19464', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp19lo45sy98x****'], ], [ 'name' => 'DBNodeGroupCount', 'in' => 'query', 'schema' => ['description' => 'The number of nodes.'."\n" ."\n" .'- For single-replica editions, the valid values are integers from 1 to 48.'."\n" ."\n" .'- For dual-replica editions, the valid values are integers from 1 to 24.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '1'], ], [ 'name' => 'DBNodeStorage', 'in' => 'query', 'schema' => ['description' => 'The storage space of a single node. Unit: GB.'."\n" ."\n" .'Valid values: 100 to 32000.'."\n" ."\n" .'> The step size is 100 GB.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '100'], ], [ 'name' => 'DBClusterClass', 'in' => 'query', 'schema' => ['description' => 'The cluster specifications.'."\n" ."\n" .'- For single-replica editions, valid values are:'."\n" ."\n" .' - **S8**'."\n" ."\n" .' - **S16**'."\n" ."\n" .' - **S32**'."\n" ."\n" .' - **S64**'."\n" ."\n" .' - **S104**'."\n" ."\n" .'- For dual-replica editions, valid values are:'."\n" ."\n" .' - **C8**'."\n" ."\n" .' - **C16**'."\n" ."\n" .' - **C32**'."\n" ."\n" .' - **C64**'."\n" ."\n" .' - **C104**', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'S8'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. You can call the [DescribeRegions](~~170875~~) operation to query the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DbNodeStorageType', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The storage class. Valid values:'."\n" ."\n" .'- **CloudESSD**: ESSD PL1 disk.'."\n" ."\n" .'- **CloudESSD\\_PL2**: ESSD PL2 disk.'."\n" ."\n" .'- **CloudESSD\\_PL3**: ESSD PL3 disk.'."\n" ."\n" .'- **CloudEfficiency**: ultra disk.'."\n" ."\n" .'- **CloudSSD**: standard SSD.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'CloudESSD'], ], [ 'name' => 'DisableWriteWindows', 'in' => 'query', 'schema' => ['description' => 'The write-inaccessible window. Separate the start time and the end time with a comma. Use the ISO 8601 format for the time.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => '2024-07-09T20:00:00+08:00,2024-07-09T21:00:00+08:00'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'DBCluster' => [ 'description' => 'The cluster.', 'type' => 'object', 'properties' => [ 'dbClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'title' => '', 'example' => 'cc-bp19lo45sy98x****'], 'orderId' => ['description' => 'The order ID.', 'type' => 'string', 'title' => '', 'example' => '21417210003****'], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BA30A000-3A4D-5B97-9420-E5D0D49F7016'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyDBCluster', 'summary' => 'Modifies the specifications of a cluster.', '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' => '[{"errorExample":"","example":"{\\n \\"DBCluster\\": {\\n \\"dbClusterId\\": \\"cc-bp19lo45sy98x****\\",\\n \\"orderId\\": \\"21417210003****\\"\\n },\\n \\"RequestId\\": \\"BA30A000-3A4D-5B97-9420-E5D0D49F7016\\"\\n}","type":"json"}]', ], 'ModifyDBClusterAccessWhiteList' => [ 'summary' => 'Modifies the IP address whitelist for a specified ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19465', 'abilityTreeNodes' => ['FEATUREclickhouseW0KOAC'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1qx68m06981****'], ], [ 'name' => 'SecurityIps', 'in' => 'query', 'schema' => ['description' => 'The IP address whitelist. The following formats are supported:'."\n" ."\n" .'- IP address: For example, 192.168.0.1. This allows the specified IP address to access the ApsaraDB for ClickHouse cluster.'."\n" ."\n" .'- CIDR block: For example, 192.168.0.0/24. This allows IP addresses from 192.168.0.1 to 192.168.0.255 to access the ApsaraDB for ClickHouse cluster.'."\n" ."\n" .'> * Do not enter 0.0.0.0.'."\n" ."\n" .'- Set this parameter to 127.0.0.1 to block access from all IP addresses.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '192.168.xx.xx'], ], [ 'name' => 'DBClusterIPArrayName', 'in' => 'query', 'schema' => ['description' => 'The name of the whitelist group to modify.'."\n" ."\n" .'> If you do not specify this parameter, the whitelist of the default group is modified.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'default'], ], [ 'name' => 'DBClusterIPArrayAttribute', 'in' => 'query', 'schema' => ['description' => 'The attribute of the whitelist group. The default value is **empty**.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'NULL'], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => ['description' => 'The modification method. Valid values:'."\n" ."\n" .'- **Cover**: Overwrites the whitelist.'."\n" ."\n" .'- **Append**: Adds IP addresses to the whitelist.'."\n" ."\n" .'- **Delete**: Removes IP addresses from the whitelist.'."\n" ."\n" .'> If you do not specify this parameter, the Cover method is used by default.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Cover'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyDBClusterAccessWhiteList', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterAccessWhiteList'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterAccessWhiteList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', ], 'ModifyDBClusterConfig' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19466', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region. You can call the [DescribeRegions](~~170875~~) operation to query the most recent list of regions.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the cluster. You can call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in a specific region. This information includes the cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1t9lbb7a4z7****'], ], [ 'name' => 'UserConfig', 'in' => 'query', 'schema' => ['description' => 'The configuration parameters to modify.'."\n" ."\n" .'> You can modify a single configuration parameter. Parameters that are not specified in the request are not affected.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '{"keep_alive_timeout":"301"}'], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => ['description' => 'The reason for the modification.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'A9AA1E0A-2AEE-5847-87CF-E4FDC0E66052'], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyDBClusterConfig', 'summary' => 'Modifies the configuration of a cluster.', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A9AA1E0A-2AEE-5847-87CF-E4FDC0E66052\\"\\n}","type":"json"}]', ], 'ModifyDBClusterConfigInXML' => [ 'summary' => 'Modifies the configuration parameters of a specified community-compatible ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '153825', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Call the [DescribeDBClusters](~~170879~~) operation to query the IDs of all clusters in a region.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The configuration parameters to modify. Call the [DescribeDBClusterConfigInXML](~~452210~~) operation to query the current configuration parameters. Then, modify the returned parameters.'."\n" ."\n" .'> When you modify a parameter, you must include all other configuration parameters in the request. If a parameter is not included, it retains its initial value or the modification fails.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ' debug 1000M 64 4096 300 100 0 10000 0.9 4194304 0 system query_log ENGINE = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_time + INTERVAL 15 DAY 7500 system query_thread_log ENGINE = MergeTree PARTITION BY event_date ORDER BY event_time TTL event_time + INTERVAL 15 DAY 7500 0 0 256 100 1 16 6871947673 3435973836'."\n"], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query available region IDs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'Reason', 'in' => 'query', 'schema' => ['description' => 'The reason for the modification.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'BDD29EB1-BE76-5CFA-9068-D34B696310BF'], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyDBClusterConfigInXML', 'description' => '> This operation supports only community-compatible clusters created after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterConfigInXML', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDD29EB1-BE76-5CFA-9068-D34B696310BF\\"\\n}","type":"json"}]', ], 'ModifyDBClusterDescription' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19467', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'DBClusterDescription', 'in' => 'query', 'schema' => ['description' => 'The cluster description. The description must meet the following requirements:'."\n" ."\n" .'- It cannot start with http\\:// or https\\://.'."\n" ."\n" .'- It must be 2 to 256 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'ClusterDescriptionTest'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyDBClusterDescription', 'summary' => 'Changes the description of a specified ApsaraDB for ClickHouse cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","type":"json"}]', ], 'ModifyDBClusterMaintainTime' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19468', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'MaintainTime', 'in' => 'query', 'schema' => ['description' => 'The maintenance window of the cluster. The format is HH:mmZ-HH:mmZ.'."\n" ."\n" .'Example: 00:00Z-01:00Z. This means that routine maintenance can be performed from 00:00 to 01:00 (UTC), which is 08:00 to 09:00 (UTC+8).'."\n" ."\n" .'> The maintenance window must start on the hour and last for one hour.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '00:00Z-01:00Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyDBClusterMaintainTime', 'summary' => 'Modifies the maintenance window for a specified ApsaraDB for ClickHouse cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyDBClusterMaintainTime'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterMaintainTime', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\"\\n}","type":"json"}]', ], 'ModifyDBConfig' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19469', 'abilityTreeNodes' => ['FEATUREclickhouseFBPCH8'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region. Call the [DescribeRegions](~~170875~~) operation to query the IDs of available regions.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1r59y779o04****'], ], [ 'name' => 'Config', 'in' => 'query', 'schema' => ['description' => 'The dictionary configuration items.'."\n" ."\n" .'> The value of the Config parameter overwrites the existing configuration. To delete a dictionary configuration, remove it from the request.'."\n" ."\n" .'Call the [DescribeDBConfig](~~2360627~~) operation to query the dictionary configuration of the target instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'title' => '', 'example' => 'test_dictionary10.0.0.03003TestUsertestPassworddefaultdictTestTable01active=1SELECT max(value) FROM dictTestTable01200600idUInt64valueString'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BF3844B6-1B12-57A0-A259-476D2079EE83'], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyDBConfig', 'summary' => 'The ModifyDBConfig operation modifies the dictionary configuration of a community-compatible cluster.', 'description' => '>'."\n" ."\n" .'This API applies only to clusters with a kernel version of 20.8 or earlier.'."\n" ."\n" .'>', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BF3844B6-1B12-57A0-A259-476D2079EE83\\"\\n}","type":"json"}]', ], 'ModifyMinorVersionGreadeType' => [ 'summary' => 'Modifies the upgrade type for a ClickHouse minor version to automatic or manual.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '147864', 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1qx68m06981****'], ], [ 'name' => 'MaintainAutoType', 'in' => 'query', 'schema' => ['description' => 'The upgrade type. Set this parameter to **false** for manual upgrades.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyMinorVersionGreadeType', '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' => 'Modifies the sync task of a community-compatible ApsaraDB for ClickHouse cluster.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '47742', 'abilityTreeNodes' => ['FEATUREclickhouseZ93UXU'], ], 'parameters' => [ [ 'name' => 'DbClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp158i5wvj436****'], ], [ 'name' => 'ClickhousePort', 'in' => 'query', 'schema' => ['description' => 'The port number of the ApsaraDB for ClickHouse cluster.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '8123'], ], [ 'name' => 'CkUserName', 'in' => 'query', 'schema' => ['description' => 'The database account of the ApsaraDB for ClickHouse cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user1'], ], [ 'name' => 'CkPassword', 'in' => 'query', 'schema' => ['description' => 'The password of the ApsaraDB for ClickHouse database account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Aa'], ], [ 'name' => 'RdsId', 'in' => 'query', 'schema' => ['description' => 'The instance ID of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'rm-uf6x3qq4t90ok****'], ], [ 'name' => 'RdsPort', 'in' => 'query', 'schema' => ['description' => 'The port number of the ApsaraDB RDS for MySQL instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '3306'], ], [ 'name' => 'RdsVpcId', 'in' => 'query', 'schema' => ['description' => 'The VPC ID of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'vpc-bp1v9dtwmqqjhwwg****'], ], [ 'name' => 'RdsUserName', 'in' => 'query', 'schema' => ['description' => 'The database account of the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'user2'], ], [ 'name' => 'RdsPassword', 'in' => 'query', 'schema' => ['description' => 'The password of the ApsaraDB RDS for MySQL database account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Rr'], ], [ 'name' => 'SkipUnsupported', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to ignore databases that do not support synchronization. Valid values:'."\n" ."\n" .'- **true**: Ignore the databases.'."\n" ."\n" .'- **false**: Do not ignore the databases.', 'type' => 'boolean', 'required' => true, 'title' => '', 'example' => 'true'], ], [ 'name' => 'LimitUpper', 'in' => 'query', 'schema' => ['description' => 'The maximum number of rows to sync per second.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '50000'], ], [ 'name' => 'RdsSynTables', 'in' => 'query', 'schema' => ['description' => 'The tables in the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'table'], ], [ 'name' => 'RdsSynDb', 'in' => 'query', 'schema' => ['description' => 'The database in the ApsaraDB RDS for MySQL instance.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'database'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '746CD303-0B82-5E8D-886D-93A9FAF3A876'], 'Status' => ['description' => 'Indicates whether the modification was successful. Valid values:'."\n" ."\n" .'- **1**: The modification was successful.'."\n" ."\n" .'- **0**: The modification failed.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], 'ErrorMsg' => ['description' => '- This parameter is not returned if **Status** is **1**.'."\n" ."\n" .'- If **Status** is **0**, this parameter indicates the reason why the modification failed.', 'type' => 'string', 'title' => '', 'example' => 'ClickHouse exception, code: 49, host: 100.100.118.132, port: 49670; Code: 49, e.displayText() = DB::Exception: Logical error: there is no global context (version 20.8.17.25)n'], 'ErrorCode' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '0'], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ModifyRDSToClickhouseDb', 'description' => '> This operation applies only to community-compatible ApsaraDB for ClickHouse clusters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ModifyRDSToClickhouseDb'], ], ], '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' => '[{"errorExample":"","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}","type":"json"}]', ], 'ReleaseClusterPublicConnection' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19472', 'abilityTreeNodes' => ['FEATUREclickhouseZHDS8I'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ReleaseClusterPublicConnection', 'summary' => 'Releases the public endpoint of a specified ApsaraDB for ClickHouse cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ReleaseClusterPublicConnection'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ReleaseClusterPublicConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\"\\n}","type":"json"}]', ], 'ResetAccountPassword' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '19473', 'abilityTreeNodes' => ['FEATUREclickhouse2H8YOY'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'AccountName', 'in' => 'query', 'schema' => ['description' => 'The database account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'test'], ], [ 'name' => 'AccountPassword', 'in' => 'query', 'schema' => ['description' => 'The new password for the database account.'."\n" ."\n" .'> - The password must contain characters from at least three of the following types: uppercase letters, lowercase letters, digits, and special characters.'."\n" ."\n" .'- The special characters are !@#$%^&\\*()\\_+-='."\n" ."\n" .'- The password must be 8 to 32 characters in length.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '123456Ff'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ResetAccountPassword', 'summary' => 'Resets the password of a database account in a specified ApsaraDB for ClickHouse cluster.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ResetAccountPassword'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ResetAccountPassword', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', ], 'RestartInstance' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '38056', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID. Call the [DescribeRegions](~~170875~~) operation to query available region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID. Call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page. Valid values:'."\n" ."\n" .'- 30 (default)'."\n" ."\n" .'- 50'."\n" ."\n" .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'RestartTime', 'in' => 'query', 'allowEmptyValue' => true, 'schema' => ['description' => 'The scheduled restart time. The time must be in the yyyy-MM-ddTHH:mmZ format and in UTC.'."\n" ."\n" .'> If this parameter is empty or specifies a time earlier than the current time, the cluster is restarted immediately.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2023-03-22T00:00:50Z'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'RestartInstance', 'summary' => 'Restarts a specified ApsaraDB for ClickHouse cluster.', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', ], 'RestartInstanceNodeList' => [ 'summary' => 'Batch restart nodes of a ClickHouse Community-compatible Edition instance.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '173004', 'abilityTreeNodes' => ['FEATUREclickhouseXSQ0JG'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc-bp108z124a8o7****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'example' => '30', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'RestartTime', 'in' => 'query', 'schema' => ['description' => 'The scheduled restart time. The time is in the yyyy-MM-ddTHH:mmZ format and is in UTC.'."\n" ."\n" .'> If this parameter is left empty or set to a time earlier than the current time, the cluster restarts immediately.', 'type' => 'string', 'required' => false, 'example' => '2023-03-22T00:00:50Z', 'title' => ''], ], [ 'name' => 'NodeList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The name of the node to restart.', 'type' => 'string', 'required' => false, 'example' => 'ck-uf6*****-2**-clickhouse-s-0-r-0', 'title' => ''], 'description' => 'The list of nodes to restart.', 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '36E3AB2E-E0DA-5C7B-8E29-89EE44926515'], ], 'title' => '', 'description' => 'Schema of response.', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'RestartInstanceNodeList', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:RestartInstanceNodeList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36E3AB2E-E0DA-5C7B-8E29-89EE44926515\\"\\n}","type":"json"}]', ], 'TagResources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '166002', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => ''."\n" ."\n" .'The ID of the ApsaraDB for ClickHouse Community-compatible Edition cluster to which you want to attach tags. You can specify up to **50** cluster IDs.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'The ID of the cluster to which you want to attach tags. You can specify up to **50** cluster IDs.'."\n" ."\n" .''."\n" ."\n" .'> Call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp1t9lbb7a4z7****', 'title' => ''], 'required' => true, 'maxItems' => 51, 'description' => 'The resource ID.', 'title' => '', 'example' => '', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. The value must be **DBCLUSTER**.', 'type' => 'string', 'required' => true, 'example' => 'DBCLUSTER', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The tag key. You can add up to **20** tag keys.', 'type' => 'string', 'required' => false, 'example' => 'testkey1', 'title' => ''], 'Value' => ['description' => 'The value of the tag key. You can add up to **20** tag values.', 'type' => 'string', 'required' => false, 'example' => 'testvalue1', 'title' => ''], ], 'required' => false, 'description' => 'The custom tag.', 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 21, 'description' => 'The list of tags.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '863D51B7-5321-41D8-A0B6-A088B0450EFD'], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'TagResources', 'summary' => 'Creates and attaches tags to one or more ApsaraDB for ClickHouse clusters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"863D51B7-5321-41D8-A0B6-A088B0450EFD\\"\\n}","type":"json"}]', ], 'TransferVersion' => [ 'methods' => ['post', 'get', 'put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '36417', 'abilityTreeNodes' => ['FEATUREclickhouse07PB80'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The ID of the region. Call the [DescribeRegions](~~170875~~) operation to query the most recent list of regions.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cn-hangzhou'], ], [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the source cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp1tm8zf130ew****'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return on each page. Valid values:'."\n" ."\n" .'- **30** (Default)'."\n" ."\n" .'- **50**'."\n" ."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '30', 'title' => '', 'example' => '30'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'title' => '', 'example' => '1'], ], [ 'name' => 'TargetDbClusterId', 'in' => 'query', 'schema' => ['description' => 'The ID of the destination cluster.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cc-bp14b39djx7zg****'], ], [ 'name' => 'SourceAccount', 'in' => 'query', 'schema' => ['description' => 'The source account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test'], ], [ 'name' => 'TargetAccount', 'in' => 'query', 'schema' => ['description' => 'The destination account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test01'], ], [ 'name' => 'SourcePassword', 'in' => 'query', 'schema' => ['description' => 'The password of the source account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Aa'], ], [ 'name' => 'TargetPassword', 'in' => 'query', 'schema' => ['description' => 'The password of the destination account.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '123456Ff'], ], [ 'name' => 'DisableWriteWindows', 'in' => 'query', 'schema' => ['description' => 'The time windows during which writes are disabled.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2025-02-08T00:00:00+08:00,2025-02-12T00:00:00+08:00'], ], [ 'name' => 'SourceClusterName', 'in' => 'query', 'schema' => ['description' => 'The name of the self-managed ClickHouse cluster.'."\n" .'To obtain the name, execute `SELECT * FROM system.clusters`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'default'], ], [ 'name' => 'SourceShards', 'in' => 'query', 'schema' => ['description' => 'The addresses and TCP ports of the shards in the self-managed ClickHouse cluster.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '192.168.0.4:9000,192.168.0.5:9000,192.168.0.6:9000'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7084CDB5-308F-5D0B-8F9B-5F7D83E09738'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'InternalError', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], 503 => [ ['errorCode' => 'ServiceUnavailable', 'errorMessage' => 'An error occurred while processing your request.', 'description' => 'An error occurred while processing your request.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'TransferVersion', 'summary' => 'Migration between versions.', 'description' => '## Prerequisites'."\n" ."\n" .'- Add the IP addresses of the source cluster to the whitelist of the destination cluster.'."\n" ."\n" .'- Add the IP addresses of the destination cluster to the whitelist of the source cluster.'."\n" ."\n" .'> You can execute the `select * from system.clusters;` statement to retrieve the IP addresses of an ApsaraDB for ClickHouse cluster.', '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7084CDB5-308F-5D0B-8F9B-5F7D83E09738\\"\\n}","type":"json"}]', ], 'UntagResources' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '166003', 'abilityTreeNodes' => ['FEATUREclickhouseCVENTL'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region ID.'."\n" ."\n" .'> Call the [DescribeRegions](~~170875~~) operation to query region IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceId', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => ''."\n" ."\n" .'The ID of the cluster from which you want to remove tags. You can specify from **1** to **50** cluster IDs.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'The ID of the cluster from which to remove tags. You can remove tags from N clusters, where N is an integer that ranges from **1 to 50**.'."\n" ."\n" .''."\n" ."\n" .'> Call the [DescribeDBClusters](~~170879~~) operation to query information about all clusters in the destination region, including cluster IDs.', 'type' => 'string', 'required' => false, 'example' => 'cc-bp1t9lbb7a4z7****', 'title' => ''], 'required' => true, 'maxItems' => 51, 'description' => 'The resource ID.', 'title' => '', 'example' => '', ], ], [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => ['description' => 'The resource type. Set the value to **DBCLUSTER**.', 'type' => 'string', 'required' => true, 'example' => 'DBCLUSTER', 'title' => ''], ], [ 'name' => 'All', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to remove all tags from the cluster. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false** (default)'."\n" ."\n" .'> This parameter is valid only when the **TagKey.N** parameter is empty.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'TagKey', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'The tag key. You can specify from 1 to **20** tag keys.', 'type' => 'string', 'required' => false, 'example' => 'testkey1', 'title' => ''], 'required' => false, 'maxItems' => 21, 'description' => 'The tag key.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ABC71772-F3A1-59CA-B811-4A5B0E0B72F8'], ], 'example' => '', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'UntagResources', 'summary' => 'Removes tags from ApsaraDB for ClickHouse clusters.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ABC71772-F3A1-59CA-B811-4A5B0E0B72F8\\"\\n}","type":"json"}]', ], 'UpgradeMinorVersion' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '147860', 'abilityTreeNodes' => ['FEATUREclickhouseN0HBPQ'], ], 'parameters' => [ [ 'name' => 'DBClusterId', 'in' => 'query', 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'cc-bp108z124a8o7****'], ], [ 'name' => 'UpgradeImmediately', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to upgrade the minor engine version immediately. Valid values:'."\n" ."\n" .'- **true**: The minor engine version is upgraded immediately.'."\n" ."\n" .'- **false**: The minor engine version is upgraded at a specified time or within the maintenance window.'."\n" ."\n" .'> The **UpgradeTime** parameter is required if you want to upgrade the minor engine version at a specified time.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'false'], ], [ 'name' => 'UpgradeVersion', 'in' => 'query', 'schema' => ['description' => 'The minor engine version to which you want to upgrade.'."\n" ."\n" .'> If you do not specify this parameter, the cluster is upgraded to the latest minor engine version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1.37.0'], ], [ 'name' => 'UpgradeTime', 'in' => 'query', 'schema' => ['description' => 'The time to perform the upgrade. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.'."\n" ."\n" .'> If you do not specify this parameter, the ApsaraDB for ClickHouse cluster is upgraded within the maintenance window.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '2022-08-07T16:38Z'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 404 => [ ['errorCode' => 'InvalidDBCluster.NotFound', 'errorMessage' => 'The DBClusterId provided does not exist in our records.', 'description' => 'The DBClusterId provided does not exist in our records.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'UpgradeMinorVersion', 'summary' => 'The UpgradeMinorVersion operation upgrades the minor engine version of a specified community-compatible ApsaraDB for ClickHouse cluster.', 'description' => '> Minor engine version upgrades are supported only for community-compatible clusters that are purchased after December 1, 2021.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpgradeMinorVersion'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:UpgradeMinorVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\"\\n}","type":"json"}]', ], ], 'endpoints' => [ ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', 'vpc' => ''], ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-wulanchabu.aliyuncs.com'], ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-beijing.aliyuncs.com'], ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-qingdao.aliyuncs.com', 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-qingdao.aliyuncs.com'], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-hongkong.aliyuncs.com', 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hongkong.aliyuncs.com'], ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-zhangjiakou.aliyuncs.com'], ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen.aliyuncs.com'], ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-chengdu.aliyuncs.com', 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-chengdu.aliyuncs.com'], ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-guangzhou.aliyuncs.com'], ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou.aliyuncs.com'], ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', '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' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', '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' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-hangzhou-finance.aliyuncs.com'], ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => 'clickhouse-vpc.cn-shenzhen-finance-1.aliyuncs.com'], ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', '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' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'clickhouse.aliyuncs.com', 'endpoint' => 'clickhouse.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'Abs.InvalidAccount.NotFound', 'message' => 'Account is not found.', 'http_code' => 404, 'description' => 'No corresponding account found.'], ['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' => '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.'], ['code' => 'COMMODITY.INVALID_COMPONENT', 'message' => 'Invalid component for commodity.', 'http_code' => 500, 'description' => 'The order configuration parameters do not meet the verification conditions, please re-match the product.'], ['code' => 'DescribeLorneLogException', 'message' => 'Cannot find taskDetail in Lorne.', 'http_code' => 500, 'description' => 'The task details of the corresponding SLS were not found.'], ['code' => 'Forbidden', 'message' => 'User not authorized to operate on the specified resource.', 'http_code' => 403, 'description' => 'The account is not granted permission to manipulate the resource'], ['code' => 'InsufficientResourceCapacity', 'message' => 'The resource is out of usage.', 'http_code' => 403, 'description' => 'The resource is out of usage.'], ['code' => 'InternalError', 'message' => 'An error occurred while processing your request.', 'http_code' => 500, 'description' => 'An error occurred while processing your request.'], ['code' => 'InternalFailure', 'message' => 'The request processing has failed due to some unknown error, exception or failure.', 'http_code' => 500, 'description' => 'An internal system error occurred with this request.'], ['code' => 'InvalidAccountName.NotFound', 'message' => 'Specified account name does not exist.', 'http_code' => 404, 'description' => 'The specified account name does not exist.'], ['code' => 'InvalidBackupRetentionPeriod.Malformed', 'message' => 'The specified parameter "BackupRetentionPeriod" is not valid.', 'http_code' => 400, 'description' => 'The request parameter BackupRetentionPeriod is invalid.'], ['code' => 'InvalidDBCluster.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The DBClusterId provided does not exist in our records.'], ['code' => 'InvalidDBClusterId.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The passed instance ID does not exist.'], ['code' => 'InvalidDBInstance.NotFound', 'message' => 'The DBClusterId provided does not exist in our records.', 'http_code' => 404, 'description' => 'The passed instance ID does not exist.'], ['code' => 'InvalidDBInstanceId.NotFound', 'message' => 'The DBInstanceId provided does not exist in our records.', 'http_code' => 404, 'description' => 'No valid instance found'], ['code' => 'InvalidPageNumber.Malformed', 'message' => 'The specified parameter "PageNumber" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter PageNumber is invalid.'], ['code' => 'InvalidPageSize.Malformed', 'message' => 'The specified parameter "PageSize" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter "PageSize" is not valid.'], ['code' => 'InvalidParameter.DBClusterVersion', 'message' => 'The version is invalid. Check whether the DBClusterVersion, MinorVersion, and MajorVersion parameters are correct.', 'http_code' => 400, 'description' => 'The version is invalid. Check whether the DBClusterVersion, MinorVersion, and MajorVersion parameters are correct.'], ['code' => 'InvalidParameter.DBNodeStorage', 'message' => 'The specified parameter "DBNodeStorage" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter "DBNodeStorage" is invalid.'], ['code' => 'InvalidRegionId.Malformed', 'message' => 'The specified parameter "RegionId" is not valid.', 'http_code' => 400, 'description' => 'The specified parameter RegionId is invalid.'], ['code' => 'InvalidSecurityIPs.Exceeded', 'message' => 'The specified parameter "SecurityIps" count is exceeded 200.', 'http_code' => 400, 'description' => 'The total number of security group IP addresses exceeds 200.'], ['code' => 'InvalidVPC.NotFound', 'message' => 'VPC or VSwitch is not valid.', 'http_code' => 404, 'description' => 'The VPC ID passed in does not exist.'], ['code' => 'InvalidVpcId.Malformed', 'message' => 'The specified parameter "VpcId" is not valid.', 'http_code' => 400, 'description' => ''], ['code' => 'ModifyServerConfigFailed', 'message' => 'Failed to modify server config.', 'http_code' => 500, 'description' => 'Failed to modify instance configuration.'], ['code' => 'OperationDenied.CKNotConnected', 'message' => 'Connect to ClickHouse Cluster Failed.', 'http_code' => 403, 'description' => 'Failed to connect to ClickHouse. Check the ClickHouse status, whitelist, and connectivity.'], ['code' => 'OperationDenied.VirtualWarehouseShardsAlign', 'message' => 'The operation is not permitted due to virtualWarehouse shards align.', 'http_code' => 403, 'description' => 'The operation is not permitted due to virtualWarehouse shards align.'], ['code' => 'PRICE.PRICING_PLAN_RESULT_NOT_FOUND', 'message' => 'Cannot find pricing plan for the commodity.', 'http_code' => 500, 'description' => 'Pricing plan not found.'], ['code' => 'ServiceUnavailable', 'message' => 'An error occurred while processing your request.', 'http_code' => 503, 'description' => 'An error occurred while processing your request.'], ['code' => 'UNAVAILABLE', 'message' => 'Service Unavailable.', 'http_code' => 502, 'description' => 'Service not available.'], ['code' => 'UNKNOWN', 'message' => 'Unknown error.', 'http_code' => 500, 'description' => 'Unknown error.'], ['code' => 'UserNotInBuyWhiteList', 'message' => 'ClickHouse is at the canary release stage. Please apply for use by submitting a ticket.', 'http_code' => 500, 'description' => 'ClickHouse is at the canary release stage. Please apply for use by submitting a ticket.'], ['code' => 'InvalidSpecification', 'message' => 'Specification parameter is not valid.', 'http_code' => 400, 'description' => 'The specification parameter is invalid.'], ['code' => 'InvalidDBInstanceStatus', 'message' => 'The specified instance state does\'t support this operation.', 'http_code' => 400, 'description' => 'The instance state does not allow the current operation.'], ['code' => 'OperationDenied.OrderProcessing', 'message' => 'The operation is not permitted due to there is an order in processing of cluster.', 'http_code' => 400, 'description' => 'There is an outstanding order, please try again later.'], ['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' => 'The instance operation changes the specification, but the incoming specification is the same as the current specification without any changes.'], ['code' => 'StorageTypeDoNotSupportBackup', 'message' => 'Current StorageType Does Not Support Backup.', 'http_code' => 400, 'description' => 'The current storage type does not support backup'], ], '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' => 'ApsaraDB for ClickHouse', 'ramCodes' => ['clickhouse'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [ [ 'name' => 'clickhouse:EncryptionType', 'schema' => ['type' => 'Array', 'description' => '加密类型'], ], ], 'ramActions' => [ [ 'apiName' => 'ModifyActiveOperationMaintainConf', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'clickhouse:ModifyActiveOperationMaintainConf', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAutoRenewAttribute', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAutoRenewAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ChangeResourceGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'DescribeColumns', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeColumns', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DeleteDBCluster', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteDBCluster', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyBackupPolicy', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DeleteSLB', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteSLB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckScaleOutBalanced', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:CheckScaleOutBalanced', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'DeleteBackupPolicy', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeSynDbs', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeSynDbs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'ResetAccountPassword', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ResetAccountPassword', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBClusterAccessWhiteList', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterAccessWhiteList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAccounts', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAccounts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'DescribeUserEncryptionKeyList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeUserEncryptionKeyList', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelActiveOperationTasks', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'clickhouse:CancelActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'CreateAccount', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAllDataSource', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAllDataSource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeAccountAuthority', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAccountAuthority', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'DescribeActiveOperationMaintainConf', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeActiveOperationMaintainConf', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateServiceLinkedRole', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateServiceLinkedRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyDBClusterDescription', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReleaseClusterPublicConnection', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ReleaseClusterPublicConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreatePortsForClickHouse', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreatePortsForClickHouse', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckServiceLinkedRole', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:CheckServiceLinkedRole', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckClickhouseToRDS', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:CheckClickhouseToRDS', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'CreateSLB', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateSLB', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBClusterConfigInXML', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterConfigInXML', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DescribeDBClusterPerformance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterPerformance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DescribeSchemas', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeSchemas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DescribeProcessList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeProcessList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'ModifyDBClusterMaintainTime', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterMaintainTime', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'UntagResources', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:UntagResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'ModifyActiveOperationTasks', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyActiveOperationTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckModifyConfigNeedRestart', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:CheckModifyConfigNeedRestart', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'CancelRestartInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:CancelRestartInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'RestartInstanceNodeList', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:RestartInstanceNodeList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDBInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateDBInstance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteAccount', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'clickhouse:DeleteAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeTables', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeTables', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBClusterAttribute', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterAttribute', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DescribeDBClusterNodeInfos', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterNodeInfos', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeActiveOperationTasks', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeActiveOperationTasks', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DescribeAllDataSources', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeAllDataSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DescribeBackupPolicy', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBClusters', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusters', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyAccountDescription', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyAccountDescription', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'TagResources', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:TagResources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'CreateBackupPolicy', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'clickhouse:CreateBackupPolicy', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AllocateClusterPublicConnection', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:AllocateClusterPublicConnection', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'UpgradeMinorVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:UpgradeMinorVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'ModifyAutoRenewAttribute', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyAutoRenewAttribute', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ], ], ], [ 'apiName' => 'ModifyDBClusterConfigInXML', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'clickhouse:ModifyDBClusterConfigInXML', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], [ '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}'], ], ], ], [ 'apiName' => 'DescribeConfigVersionDifference', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeConfigVersionDifference', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBClusterAccessWhiteList', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterAccessWhiteList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeConfigHistory', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeConfigHistory', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DescribeDBClusterNetInfoItems', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'clickhouse:DescribeDBClusterNetInfoItems', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ClickHouse', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ '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}'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}'], ['validationType' => 'always', 'resourceType' => 'DBCluster', 'arn' => 'acs:clickhouse:{#regionId}:{#accountId}:dbcluster/*'], ], ], ];