'1.0', 'info' => [ 'style' => 'RPC', 'product' => 'clickhouse', 'version' => '2023-05-22', ], 'directories' => [ [ 'id' => 222452, 'title' => '集群管理', 'type' => 'directory', 'children' => [ 'CreateDBInstance', 'DeleteDBInstance', 'StartDBInstance', 'RestartDBInstance', 'StopDBInstance', 'ModifyDBInstanceClass', 'ModifyDBInstanceAttribute', 'DescribeDBInstances', 'DescribeDBInstanceAttribute', 'UpgradeMinorVersion', ], ], [ 'id' => 222463, 'title' => '账号管理', 'type' => 'directory', 'children' => [ 'CreateAccount', 'DeleteAccount', 'ResetAccountPassword', 'ModifyAccountDescription', 'ModifyAccountAuthority', 'DescribeAccounts', 'DescribeAccountAuthority', ], ], [ 'id' => 222471, 'title' => '数据库管理', 'type' => 'directory', 'children' => [ 'CreateDB', 'DeleteDB', 'DescribeDBInstanceDataSources', ], ], [ 'id' => 222475, 'title' => '网络管理', 'type' => 'directory', 'children' => [ 'CreateEndpoint', 'DeleteEndpoint', 'ModifyDBInstanceConnectionString', 'ModifySecurityIPList', 'DescribeSecurityIPList', 'DescribeEndpoints', ], ], [ 'id' => 222482, 'title' => '任务及日志管理', 'type' => 'directory', 'children' => [ 'DescribeProcessList', 'KillProcess', 'DescribeSlowLogTrend', 'DescribeSlowLogRecords', ], ], [ 'id' => 222487, 'title' => '备份管理', 'type' => 'directory', 'children' => [ 'ModifyBackupPolicy', 'DescribeBackupPolicy', 'DeleteBackupPolicy', 'CreateBackupPolicy', 'DescribeBackups', ], ], [ 'id' => 222493, 'title' => '参数管理', 'type' => 'directory', 'children' => [ 'ModifyDBInstanceConfig', 'DescribeDBInstanceConfigChangeLog', 'DescribeDBInstanceConfig', ], ], [ 'id' => 222497, 'title' => '其他', 'type' => 'directory', 'children' => [ 'ChangeResourceGroup', ], ], [ 'id' => 0, 'title' => '其它', 'type' => 'directory', 'children' => [ 'ListClickHouseDBTimezones', 'DeleteWhitelistTemplate', 'CreateWhitelistTemplate', 'DetachWhitelistTemplateToInstance', 'UpdateWhitelistTemplate', 'GetWhitelistTemplate', 'AttachWhitelistTemplateToInstance', 'ListWhitelistTemplates', 'ListInstanceLinkedWhitelistTemplates', ], ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateDBInstance' => [ 'summary' => '调用CreateDBInstance接口创建ClickHouse企业版集群。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '182031', 'abilityTreeNodes' => [ 'FEATUREclickhouseN0HBPQ', ], ], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => [ 'title' => '幂等参数', 'description' => '用于保证请求的幂等性，防止重复提交请求。'."\n" .'该参数值由客户端生成，要保证在不同请求间唯一，最大值不超过64个ASCII字符，且该参数值中不能包含非ASCII字符。', 'type' => 'string', 'required' => false, 'example' => 'AB', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => '地域id', 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ZoneId', 'in' => 'query', 'schema' => [ 'title' => '可用区', 'description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], ], [ 'name' => 'VpcId', 'in' => 'query', 'schema' => [ 'title' => 'VPC ID。', 'description' => 'VPC ID。', 'type' => 'string', 'required' => false, 'example' => 'vpc-uf6xmupdn7v6ui9f****', ], ], [ 'name' => 'VswitchId', 'in' => 'query', 'schema' => [ 'title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-uf632qye9oqt4x4sr****', ], ], [ 'name' => 'DBInstanceDescription', 'in' => 'query', 'schema' => [ 'title' => '集群说明。', 'description' => '集群说明。', 'type' => 'string', 'required' => false, 'example' => '集群测试', ], ], [ 'name' => 'EngineVersion', 'in' => 'query', 'schema' => [ 'title' => '引擎版本。', 'description' => '引擎版本。', 'type' => 'string', 'required' => false, 'example' => '23.8', ], ], [ 'name' => 'ScaleMin', 'in' => 'query', 'schema' => [ 'title' => 'serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。不推荐使用，当前建议使用NodeCount，NodeScaleMin，NodeScaleMax设置弹性能力。', 'type' => 'string', 'required' => false, 'example' => '8', ], ], [ 'name' => 'ScaleMax', 'in' => 'query', 'schema' => [ 'title' => 'serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。不推荐使用，当前建议使用NodeCount，NodeScaleMin，NodeScaleMax设置弹性能力。', 'type' => 'string', 'required' => false, 'example' => '32', ], ], [ 'name' => 'Engine', 'in' => 'query', 'schema' => [ 'title' => '引擎类型。', 'description' => '引擎类型。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'enum' => [ 'clickhouse', ], ], ], [ 'name' => 'MultiZone', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '多可用区配置。', 'description' => '多可用区配置。', 'type' => 'array', 'items' => [ 'title' => '多可用区配置。', 'description' => '多可用区配置。', 'type' => 'object', 'properties' => [ 'ZoneId' => [ 'title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou-h', ], 'VSwitchIds' => [ 'title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'array', 'items' => [ 'title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'required' => false, 'example' => 'vsw-8vb05l07h3sdayqhe****', ], 'required' => false, ], ], 'required' => false, ], 'required' => false, ], ], [ 'name' => 'DeploySchema', 'in' => 'query', 'schema' => [ 'title' => '集群可用区部署状态。', 'description' => '集群可用区部署状态。', 'type' => 'string', 'required' => false, 'example' => 'multi_az', ], ], [ 'name' => 'SourceDBInstanceId', 'in' => 'query', 'schema' => [ 'title' => '集群例ID。', 'description' => '集群例ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze1*********', ], ], [ 'name' => 'BackupSetId', 'in' => 'query', 'schema' => [ 'title' => '备份集ID。', 'description' => '备份集ID。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'title' => '集群所属的资源组ID。', 'description' => '集群资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-*****', ], ], [ 'name' => 'NodeScaleMax', 'in' => 'query', 'schema' => [ 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'description' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '4', ], ], [ 'name' => 'NodeScaleMin', 'in' => 'query', 'schema' => [ 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'description' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '32', ], ], [ 'name' => 'NodeCount', 'in' => 'query', 'schema' => [ 'title' => '节点个数，取值范围2-16', 'description' => '节点个数，取值范围2-16。使用NodeScaleMin、NodeScaleMax配置弹性区间时必填。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64', 'minimum' => '2', 'example' => '2', ], ], [ 'name' => 'StorageQuota', 'in' => 'query', 'schema' => [ 'title' => '存储预购量（GB）', 'description' => '存储预购量（GB）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '100', ], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'title' => '存储类型。', 'description' => '存储类型。', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'enum' => [ 'oss', 'ESSD_L1', 'ESSD_L2', 'ESSD_L3', 'SSD', 'ESSD_L0', ], ], ], [ 'name' => 'DBTimeZone', 'in' => 'query', 'schema' => [ 'title' => '数据库内核时区设置，应为IANA时区标识符。', 'description' => '数据库内核时区设置，应为IANA时区标识符。', 'type' => 'string', 'required' => false, ], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'default' => 'enterprise', ], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '标签列表', 'description' => '标签列表', 'type' => 'array', 'items' => [ 'title' => '标签列表。', 'description' => '标签列表。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '实例标签键。', 'description' => '实例标签键。', 'type' => 'string', 'required' => false, 'example' => 'user_123', ], 'Value' => [ 'title' => '实例标签值。', 'description' => '实例标签值。', 'type' => 'string', 'required' => false, 'example' => '示例字符串', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, 'minItems' => 0, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', ], 'Data' => [ 'title' => '返回结果。', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'OrderId' => [ 'title' => '订单ID。', 'description' => '订单ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '21154955706****', ], 'ConnectionString' => [ 'title' => '连接地址。', 'description' => '连接地址。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"OrderId\\": 0,\\n \\"ConnectionString\\": \\"cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com\\"\\n }\\n}","type":"json"}]', 'title' => '创建集群', ], 'DeleteDBInstance' => [ 'summary' => '调用DeleteDBInstance接口释放云数据库ClickHouse企业版集群。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185379', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '目标集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\"\\n }\\n}","type":"json"}]', 'title' => '释放集群', ], 'StartDBInstance' => [ 'summary' => '调用StartDBInstance接口启动云数据库ClickHouse企业版集群。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '189351', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100000837', ], 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => '企业版集群测试', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000837,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', 'title' => '启动集群', ], 'RestartDBInstance' => [ 'summary' => '调用RestartDBInstance接口重启云数据库ClickHouse企业版集群。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '192305', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100001080', ], 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => '企业版集群测试', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100001080,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', 'title' => '重启集群', ], 'StopDBInstance' => [ 'summary' => '调用StopDBInstance接口暂停云数据库ClickHouse企业版集群。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '189348', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'description' => '任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100000785', ], 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-bp100p4q1g9z3****', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => '企业版集群测试', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000785,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', 'title' => '暂停集群', ], 'ModifyDBInstanceClass' => [ 'summary' => '调用ModifyDBInstanceClass接口修改集群的弹性配置。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '188578', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxxxx', ], ], [ 'name' => 'ScaleMin', 'in' => 'query', 'schema' => [ 'title' => '（参数废弃）serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8', ], ], [ 'name' => 'ScaleMax', 'in' => 'query', 'schema' => [ 'title' => '（参数废弃）serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32', ], ], [ 'name' => 'NodeScaleMax', 'in' => 'query', 'schema' => [ 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'description' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '4', ], ], [ 'name' => 'NodeScaleMin', 'in' => 'query', 'schema' => [ 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'description' => 'serverless节点弹性伸缩最小值。取值范围4-32', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '128', 'minimum' => '4', 'example' => '32', ], ], [ 'name' => 'NodeCount', 'in' => 'query', 'schema' => [ 'title' => '节点个数，取值范围2-16', 'description' => '节点个数，取值范围2-16', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '64', 'minimum' => '1', 'example' => '2', ], ], [ 'name' => 'StorageQuota', 'in' => 'query', 'schema' => [ 'description' => '存储预购量（GB）', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '100', ], ], [ 'name' => 'StorageType', 'in' => 'query', 'schema' => [ 'title' => '存储类型。', 'description' => '存储类型。', 'type' => 'string', 'required' => false, 'example' => 'OSS', 'enum' => [ 'oss', 'ESSD_L1', 'ESSD_L2', 'ESSD_L3', 'SSD', 'ESSD_L0', ], ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'title' => '计算组id', 'description' => '计算组id', 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], 'Data' => [ 'title' => '返回数据。', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'TaskId' => [ 'title' => '任务ID。', 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '10000****', ], 'ScaleMin' => [ 'title' => 'serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int64', 'example' => '2', ], 'ScaleMax' => [ 'title' => 'serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int64', 'example' => '32', ], 'DBInstanceID' => [ 'title' => '集群ID。', 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int64', 'example' => 'cc-xxxxxxx'."\n", ], 'DBInstanceName' => [ 'title' => '集群名称。', 'description' => '集群名称。', 'type' => 'string', 'example' => 'cc-xxxxxxx'."\n", ], 'ComputingGroupId' => [ 'type' => 'string', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSpecification', 'errorMessage' => 'Specification parameter is not valid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"ScaleMin\\": 2,\\n \\"ScaleMax\\": 32,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"ComputingGroupId\\": \\"\\"\\n }\\n}","type":"json"}]', 'title' => '修改集群弹性配置', ], 'ModifyDBInstanceAttribute' => [ 'summary' => '调用ModifyDBInstanceAttribute接口修改集群的配置属性。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', ], ], [ 'name' => 'AttributeType', 'in' => 'query', 'schema' => [ 'description' => '需要修改的类型。'."\n" .'- MaintainTime：修改运维时间'."\n" .'- DBInstanceDescription：修改实例名称', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'example' => 'DBInstanceDescription', 'enum' => [ 'MaintainTime', 'DBInstanceDescription', ], ], ], [ 'name' => 'AttributeValue', 'in' => 'query', 'schema' => [ 'description' => '需要修改的内容。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', 'title' => '修改集群的配置属性', ], 'DescribeDBInstances' => [ 'summary' => '调用DescribeDBInstances接口查询集群列表。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '183135', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceIds', 'in' => 'query', 'schema' => [ 'description' => '集群ID列表，多个集群ID之间用英文半角逗号（,）分隔。', 'type' => 'string', 'required' => false, 'example' => 'cc-xxxxx,cx-xxxx', ], ], [ 'name' => 'DBInstanceStatus', 'in' => 'query', 'schema' => [ 'description' => '集群状态。', 'type' => 'string', 'required' => false, 'example' => 'active', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '集群描述。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'description' => '资源组ID。', 'type' => 'string', 'required' => false, 'example' => 'rg-4690g37929****', ], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ 'title' => '标签信息。', 'description' => '标签信息。', 'type' => 'array', 'items' => [ 'title' => '标签信息。', 'description' => '标签信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签键。', 'description' => '标签键。', 'type' => 'string', 'required' => false, 'example' => 'user_123', ], 'Value' => [ 'title' => '标签值。', 'description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => '示例值', ], ], 'required' => false, ], 'required' => false, 'maxItems' => 20, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总记录数', 'type' => 'string', 'example' => '1', ], 'PageSize' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'PageNumber' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DBInstances' => [ 'description' => '实例详情列表。', 'type' => 'array', 'items' => [ 'description' => '实例详情。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-xxxxxxx', ], 'Description' => [ 'description' => '参数描述。', 'type' => 'string', 'example' => 'test_desc', ], 'Engine' => [ 'description' => '引擎类型。', 'type' => 'string', 'example' => 'clickhouse', ], 'EngineVersion' => [ 'description' => '引擎版本。', 'type' => 'string', 'example' => '22.8', ], 'AliUid' => [ 'description' => '用户ID。', 'type' => 'string', 'example' => '1294****', ], 'Bid' => [ 'description' => '渠道ID。', 'type' => 'string', 'example' => '186681****', ], 'RegionId' => [ 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'ZoneId' => [ 'description' => '可用区ID', 'type' => 'string', 'example' => 'cn-hangzhou-i', ], 'ChargeType' => [ 'description' => '付费方式。 取值：'."\n" ."\n" .'- PrePaid：包年包月。'."\n" .'- PostPaid：按量付费。', 'type' => 'string', 'example' => 'PostPaid', ], 'Status' => [ 'description' => '实例状态。', 'type' => 'string', 'example' => 'active', ], 'VpcId' => [ 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-uf6kg****', ], 'VSwitchId' => [ 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-8vb5mw****', ], 'ScaleMin' => [ 'description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ScaleMax' => [ 'description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '13', ], 'ExpireTime' => [ 'description' => '到期时间。', 'type' => 'string', 'example' => '2024-02-16 11:51:06', ], 'LockMode' => [ 'description' => '锁定模式。', 'type' => 'string', 'example' => '0', ], 'LockReason' => [ 'description' => '锁定原因。', 'type' => 'string', 'example' => 'null', ], 'MaintainStartTime' => [ 'description' => '可维护时间开始时间。', 'type' => 'string', 'example' => '00:00Z', ], 'MaintainEndTime' => [ 'description' => '可维护时间结束时间。', 'type' => 'string', 'example' => '04:00:00Z', ], 'DeletionProtection' => [ 'description' => '是否已开启释放保护功能。', 'type' => 'string', 'example' => 'False', ], 'ResourceGroupId' => [ 'description' => '资源组ID。', 'type' => 'string', 'example' => 'rg-acfmzy****', ], 'CreateTime' => [ 'description' => '创建时间。', 'type' => 'string', 'example' => '2022-12-04 21:16:15', ], 'Tags' => [ 'description' => '标签组。', 'type' => 'array', 'items' => [ 'description' => '标签。', 'type' => 'object', 'properties' => [ 'Key' => [ 'description' => '标签键。', 'type' => 'string', 'example' => 'tag', ], 'Value' => [ 'description' => '标签值。', 'type' => 'string', 'example' => 'test', ], ], ], ], 'StorageType' => [ 'title' => '实例存储类型', 'description' => '实例存储类型', 'type' => 'string', 'example' => 'oss', ], ], ], ], ], ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-xxxxxxx\\",\\n \\"Description\\": \\"test_desc\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"22.8\\",\\n \\"AliUid\\": \\"1294****\\",\\n \\"Bid\\": \\"186681****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"Status\\": \\"active\\",\\n \\"VpcId\\": \\"vpc-uf6kg****\\",\\n \\"VSwitchId\\": \\"vsw-8vb5mw****\\",\\n \\"ScaleMin\\": 1,\\n \\"ScaleMax\\": 13,\\n \\"ExpireTime\\": \\"2024-02-16 11:51:06\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"DeletionProtection\\": \\"False\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzy****\\",\\n \\"CreateTime\\": \\"2022-12-04 21:16:15\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StorageType\\": \\"oss\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', 'title' => '查询集群列表', ], 'DescribeDBInstanceAttribute' => [ 'summary' => '调用DescribeDBInstanceAttribute接口查询云数据库ClickHouse企业版集群的详细信息。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '183134', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'enumValueTitles' => [ 'cn-beijing' => 'cn-beijing', ], 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', ], 'Data' => [ 'title' => '返回结果。', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '集群ID。', 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Description' => [ 'title' => '集群描述。', 'description' => '集群描述。', 'type' => 'string', 'example' => '集群测试', ], 'Engine' => [ 'title' => '引擎类型。', 'description' => '引擎类型。', 'type' => 'string', 'example' => 'clickhouse', ], 'EngineVersion' => [ 'title' => '引擎版本。', 'description' => '引擎版本。', 'type' => 'string', 'example' => '23.8', ], 'AliUid' => [ 'title' => '阿里云账号ID。', 'description' => '阿里云账号ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '140692647406****', ], 'Bid' => [ 'title' => '渠道ID。', 'description' => '渠道ID。', 'type' => 'string', 'example' => 'PD39050615820269****', ], 'RegionId' => [ 'title' => '地域ID。', 'description' => '地域ID。', 'type' => 'string', 'example' => 'cn-hangzhou', ], 'DeploySchema' => [ 'title' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" ."\n" .'- single_az：server部署到主可用区ZoneId。'."\n" .'- multi_az：server部署到多可用区MultiZones。'."\n" ."\n" .'keeper始终部署到多可用区MultiZones。', 'description' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" ."\n" .'- single_az：server部署到主可用区ZoneId。'."\n" .'- multi_az：server部署到多可用区MultiZones。'."\n" ."\n" .'keeper始终部署到多可用区MultiZones。', 'type' => 'string', 'example' => 'single_az', ], 'MultiZones' => [ 'title' => '多可用信息。', 'description' => '多可用信息。', 'type' => 'array', 'items' => [ 'title' => '多可用信息。', 'description' => '多可用信息。', 'type' => 'object', 'properties' => [ 'VSwitchIds' => [ 'title' => '交换机ID。', 'description' => '交换机ID数组。', 'type' => 'array', 'items' => [ 'title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-bj9kpwhcb9iekphje1ljz', ], ], 'ZoneId' => [ 'title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h', ], ], ], ], 'ChargeType' => [ 'title' => '付费方式。 '."\n" .'企业版集群的付费方式都是按量付费方式。', 'description' => '付费方式。 '."\n" .'企业版集群的付费方式都是按量付费方式。', 'type' => 'string', 'example' => 'POSTPAY', ], 'Status' => [ 'title' => '实例状态。', 'description' => '实例状态。', 'type' => 'string', 'example' => 'ACTIVATION', ], 'VpcId' => [ 'title' => 'VPC ID。', 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-wz9duj8xd6r1gzhsg*****', ], 'VSwitchId' => [ 'title' => '交换机ID。', 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-uf67ij56zm9x4uc6hmilg', ], 'ScaleMin' => [ 'title' => 'serverless弹性伸缩最小值。', 'description' => 'serverless弹性伸缩最小值。', 'type' => 'integer', 'format' => 'int32', 'example' => '8', ], 'ScaleMax' => [ 'title' => 'serverless弹性伸缩最大值。', 'description' => 'serverless弹性伸缩最大值。', 'type' => 'integer', 'format' => 'int32', 'example' => '32', ], 'StorageSize' => [ 'title' => '存储空间大小。单位：GB', 'description' => '存储空间大小。单位：GB', 'type' => 'integer', 'format' => 'int32', 'example' => '12', ], 'StorageType' => [ 'title' => '存储类型。', 'description' => '存储类型。', 'type' => 'string', 'example' => '100', ], 'ObjectStoreSize' => [ 'title' => '对象存储大小。', 'description' => '对象存储大小。', 'type' => 'string', 'example' => '13', ], 'ExpireTime' => [ 'title' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" .'>按量付费集群无到期时间，返回值为空。', 'description' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" .'>按量付费集群无到期时间，返回值为空。', 'type' => 'string', 'example' => '2024-04-17T08:14:48Z', ], 'LockMode' => [ 'title' => '集群的锁定模式。', 'description' => '集群的锁定模式。', 'type' => 'string', 'example' => '0', ], 'LockReason' => [ 'title' => '锁定原因。', 'description' => '锁定原因。', 'type' => 'string', 'example' => 'nolock', ], 'MaintainStartTime' => [ 'title' => '可维护时间开始时间。', 'description' => '可维护时间开始时间。', 'type' => 'string', 'example' => '11:00Z', ], 'MaintainEndTime' => [ 'title' => '可维护时间结束时间。', 'description' => '可维护时间结束时间。', 'type' => 'string', 'example' => '12:00Z', ], 'DeletionProtection' => [ 'title' => '是否已开启释放保护功能。', 'description' => '是否已开启释放保护功能。', 'type' => 'boolean', 'example' => '0/1', ], 'ResourceGroupId' => [ 'title' => '资源ID。', 'description' => '资源ID。', 'type' => 'string', 'example' => 'rg-acfmzygvt54****', ], 'Tags' => [ 'title' => '标签信息。', 'description' => '标签信息。', 'type' => 'array', 'items' => [ 'title' => '标签信息。', 'description' => '标签信息。', 'type' => 'object', 'properties' => [ 'Key' => [ 'title' => '标签的名称。', 'description' => '标签的名称。', 'type' => 'string', 'example' => 'id', ], 'Value' => [ 'title' => '标签的值。', 'description' => '标签的值。', 'type' => 'string', 'example' => 'ck', ], ], ], ], 'Nodes' => [ 'title' => '节点信息。', 'description' => '节点信息。', 'type' => 'array', 'items' => [ 'title' => '节点信息。', 'description' => '节点信息。', 'type' => 'object', 'properties' => [ 'ZoneId' => [ 'title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'NodeStatus' => [ 'title' => '节点运行状态。', 'description' => '节点运行状态。', 'type' => 'string', 'example' => 'active', ], ], ], ], 'CreateTime' => [ 'title' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', 'description' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', 'type' => 'string', 'example' => '2023-09-14T08:14:48Z', ], 'EngineMinorVersion' => [ 'title' => '集群引擎的小版本号。', 'description' => '集群引擎的小版本号。', 'type' => 'string', 'example' => '23.8.1.41495_6', ], 'LatestEngineMinorVersion' => [ 'title' => '最新内核小版本号。', 'description' => '最新内核小版本号。', 'type' => 'string', 'example' => '23.8.1.41495_6', ], 'DisabledPorts' => [ 'title' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', 'description' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', 'type' => 'string', 'example' => '9001,8123', ], 'ZoneId' => [ 'title' => '可用区ID。', 'description' => '可用区ID。', 'type' => 'string', 'example' => 'cn-hangzhou-h', ], 'StorageQuota' => [ 'title' => '存储预购量（GB）。', 'description' => '存储预购量（GB）。', 'type' => 'string', 'example' => '100', ], 'NodeScaleMax' => [ 'title' => 'Serverless节点弹性最大值。', 'description' => 'Serverless节点弹性最大值。', 'type' => 'string', 'example' => '32', ], 'NodeScaleMin' => [ 'title' => 'Serverless节点弹性最小值。', 'description' => 'Serverless节点弹性最小值。', 'type' => 'string', 'example' => '4', ], 'NodeCount' => [ 'title' => '节点数量。', 'description' => '节点数量。', 'type' => 'string', 'example' => '2', ], 'Category' => [ 'title' => '类型，取值说明：'."\n" ."\n" .'- enterprise 企业版', 'description' => '类型，取值说明：'."\n" ."\n" .'- enterprise 企业版', 'type' => 'string', 'example' => 'enterprise', ], 'ClickObserveServiceStatus' => [ 'title' => 'ClickObserve服务状态', 'description' => 'ClickObserve服务状态', 'type' => 'string', 'example' => 'activation', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Description\\": \\"集群测试\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"23.8\\",\\n \\"AliUid\\": 0,\\n \\"Bid\\": \\"PD39050615820269****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeploySchema\\": \\"single_az\\",\\n \\"MultiZones\\": [\\n {\\n \\"VSwitchIds\\": [\\n \\"vsw-bj9kpwhcb9iekphje1ljz\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-wz9duj8xd6r1gzhsg*****\\",\\n \\"VSwitchId\\": \\"vsw-uf67ij56zm9x4uc6hmilg\\",\\n \\"ScaleMin\\": 8,\\n \\"ScaleMax\\": 32,\\n \\"StorageSize\\": 12,\\n \\"StorageType\\": \\"100\\",\\n \\"ObjectStoreSize\\": \\"13\\",\\n \\"ExpireTime\\": \\"2024-04-17T08:14:48Z\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"nolock\\",\\n \\"MaintainStartTime\\": \\"11:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmzygvt54****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"ck\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"NodeStatus\\": \\"active\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-14T08:14:48Z\\",\\n \\"EngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"LatestEngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"DisabledPorts\\": \\"9001,8123\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageQuota\\": \\"100\\",\\n \\"NodeScaleMax\\": \\"32\\",\\n \\"NodeScaleMin\\": \\"4\\",\\n \\"NodeCount\\": \\"2\\",\\n \\"Category\\": \\"enterprise\\",\\n \\"ClickObserveServiceStatus\\": \\"activation\\"\\n }\\n}","type":"json"}]', 'title' => '查询集群的详细信息', ], 'UpgradeMinorVersion' => [ 'summary' => '调用UpgradeMinorVersion接口升级指定云数据库ClickHouse企业版集群的内核小版本。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '196979', 'abilityTreeNodes' => [ 'FEATUREclickhouseN0HBPQ', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例ID', 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1jyis8p15we****', ], ], [ 'name' => 'SwitchTimeMode', 'in' => 'query', 'schema' => [ 'title' => '切换模式', 'description' => '是否立即升级，取值说明：'."\n" .'- **Immediate**：立即升级。'."\n" .'- **MaintainTime**：在可运维时间段内升级。'."\n" .'- **SpecifyTime**：指定时间升级。', 'type' => 'string', 'required' => false, 'example' => 'Immediate', 'default' => 'Immediate', 'enum' => [ 'Immediate', 'MaintainTime', 'SpecifyTime', ], ], ], [ 'name' => 'SwitchTime', 'in' => 'query', 'schema' => [ 'title' => '指定时间点切换时，指定切换时间点。', 'description' => '指定的升级时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。'."\n" .'> 当SwitchTimeMode为SpecifyTime时，需要通过该参数指定升级时间。', 'type' => 'string', 'required' => false, 'example' => '2023-01-09T05:00:00Z', ], ], [ 'name' => 'TargetMinorVersion', 'in' => 'query', 'schema' => [ 'title' => '目标内核小版本，默认升级到最新。', 'description' => '目标内核小版本。'."\n" .'>默认不填写，直接升级到最新的内核小版本。', 'type' => 'string', 'required' => false, 'example' => '23.8.1.41495_6', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceName' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'cc-uf6x229yeq166****', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"cc-uf6x229yeq166****\\"\\n }\\n}","type":"json"}]', 'title' => '升级内核小版本', ], 'CreateAccount' => [ 'summary' => '调用CreateAccount接口为云数据库ClickHouse企业版集群创建数据库账号。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185272', 'abilityTreeNodes' => [ 'FEATUREclickhouseL1079N', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'AccountType', 'in' => 'query', 'schema' => [ 'description' => '数据库账号的类型，取值说明：'."\n" .'- **NormalAccount**：普通账号。'."\n" .'- **SuperAccount**：高权限账号。', 'type' => 'string', 'required' => true, 'example' => 'NormalAccount', 'enum' => [ 'SuperAccount', 'NormalAccount', ], ], ], [ 'name' => 'Account', 'in' => 'query', 'schema' => [ 'description' => '数据库账号，设置规则如下。'."\n" .'- 名称唯一。'."\n" .'- 由小写字母、数字或下划线组成。'."\n" .'- 以小写字母开头，以小写字母或数字结尾。'."\n" .'- 长度为2~64个字符。', 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '数据库账号密码，设置规则如下。'."\n" ."\n" .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" ."\n" .'- !@#$%^&*()_+-=为特殊字符。'."\n" ."\n" .'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => 'a1b2c3d4@', ], ], [ 'name' => 'DmlAuthSetting', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '授权信息。', 'type' => 'object', 'properties' => [ 'DmlAuthority' => [ 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" .'- **0**：允许进行读取、写入和更改设置的查询'."\n" .'- **1**：仅允许进行读取数据的查询。'."\n" .'- **2**：允许进行读取数据和更改设置的查询。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'enum' => [ '0', '1', '2', ], ], 'DdlAuthority' => [ 'description' => '是否授予数据库账号DDL权限，取值如下：'."\n" ."\n" .'- **true**：允许DDL。'."\n" .'- **false**：禁止DDL。', 'type' => 'boolean', 'required' => false, 'example' => 'true', ], 'AllowDictionaries' => [ 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'array', 'items' => [ 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'dc1,dc2', ], 'required' => false, ], 'AllowDatabases' => [ 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'array', 'items' => [ 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'db1,db2', ], 'required' => false, ], ], 'required' => false, ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '备注说明。', 'type' => 'string', 'required' => false, 'example' => '测试使用', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA****', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Account' => [ 'description' => '数据库账号。', 'type' => 'string', 'example' => 'test1', ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidAccountType.Malformed', 'errorMessage' => 'The specified parameter "AccountType" is not valid.', ], [ 'errorCode' => 'InvalidAccountName.Malformed', 'errorMessage' => 'The specified parameter "Account" is not valid.', ], [ 'errorCode' => 'InvalidAccountPassword.Malformed', 'errorMessage' => 'The specified parameter "Password" is not valid.', ], ], 403 => [ [ 'errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', 'title' => '创建账号', ], 'DeleteAccount' => [ 'summary' => '调用DeleteAccount接口删除账号。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '185273', 'abilityTreeNodes' => [ 'FEATUREclickhouse2H8YOY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'Account', 'in' => 'query', 'schema' => [ 'description' => '目标数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '21D06907-CEA5-561D-B6B1-198BCCE99ED1', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Account' => [ 'description' => '数据库账号。', 'type' => 'string', 'example' => 'test1', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21D06907-CEA5-561D-B6B1-198BCCE99ED1\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', 'title' => '删除账号', ], 'ResetAccountPassword' => [ 'summary' => '调用ResetAccountPassword接口重置云数据库ClickHouse企业版集群的数据库账号密码。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185276', 'abilityTreeNodes' => [ 'FEATUREclickhouse2H8YOY', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Account', 'in' => 'query', 'schema' => [ 'description' => '数据库账号名称。', 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'Password', 'in' => 'query', 'schema' => [ 'description' => '数据库账号的密码。'."\n" ."\n" .'- 由大写字母、小写字母、数字和特殊字符中的至少三种组成。'."\n" .'- !@#$%^&*()_+-=为特殊字符。'."\n" .'- 长度为8~32个字符。', 'type' => 'string', 'required' => true, 'example' => '123456Aa', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品名称。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '5A6A077A-577C-536E-AC13-8E715D7A34C8', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Account' => [ 'description' => '数据库账号。', 'type' => 'string', 'example' => 'test1', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6A077A-577C-536E-AC13-8E715D7A34C8\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', 'title' => '重置账号的密码', ], 'ModifyAccountDescription' => [ 'summary' => '调用ModifyAccountDescription接口修改账号的备注信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185303', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域 ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1anv7jo84t****', ], ], [ 'name' => 'Account', 'in' => 'query', 'schema' => [ 'description' => '账号名称', 'type' => 'string', 'required' => true, 'example' => 'testuser', ], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => [ 'description' => '账号备注。', 'type' => 'string', 'required' => true, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7FFC9EBE-5023-5D5D-A5F0-1607E0F2****', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp1anv7jo84t****', ], 'Account' => [ 'description' => '数据库账号。', 'type' => 'string', 'example' => 'testuser', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FFC9EBE-5023-5D5D-A5F0-1607E0F2****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp1anv7jo84t****\\",\\n \\"Account\\": \\"testuser\\"\\n }\\n}","type":"json"}]', 'title' => '修改账号备注', ], 'ModifyAccountAuthority' => [ 'summary' => '调用ModifyAccountAuthority接口修改账号的授权信息。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185304', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'Account', 'in' => 'query', 'schema' => [ 'description' => '数据库账号。', 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], [ 'name' => 'DmlAuthSetting', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => '授权信息。', 'type' => 'object', 'properties' => [ 'DmlAuthority' => [ 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" ."\n" .'- **0**：Read，Write，and Change settings queries are allowed.'."\n" ."\n" .'- **1**：Only Read data queries are allowed.'."\n" ."\n" .'- **2**：Read data and Change settings queries are allowed.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'enum' => [ '0', '1', '2', ], ], 'DdlAuthority' => [ 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" ."\n" .'- **true**：允许DDL。'."\n" .'- **false**：禁止DDL。', 'type' => 'boolean', 'required' => true, 'example' => 'true', ], 'AllowDictionaries' => [ 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'array', 'items' => [ 'description' => '需要授权的字典列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'db1,db2', ], 'required' => false, ], 'AllowDatabases' => [ 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'array', 'items' => [ 'description' => '需要授权的数据库列表。如果有多个，用英文逗号（,）隔开。', 'type' => 'string', 'required' => false, 'example' => 'db1,db2', ], 'required' => false, ], ], 'required' => true, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Account' => [ 'description' => '数据库账号。', 'type' => 'string', 'example' => 'test1', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', 'title' => '修改账号的授权信息', ], 'DescribeAccounts' => [ 'summary' => '调用DescribeAccounts接口查询指定云数据库ClickHouse集群的数据库账号列表。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185288', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页数。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数，取值：'."\n" .'- **30**（默认值）'."\n" .'- **50**'."\n" .'- **100**', 'type' => 'string', 'required' => false, 'example' => '30', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageNumber' => [ 'description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'PageSize' => [ 'description' => '每页记录数，取值说明：'."\n" .'- **30**（默认值）'."\n" .'- **50**'."\n" .'- **100**', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'Accounts' => [ 'description' => '账号列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Account' => [ 'description' => '数据库账号。', 'type' => 'string', 'example' => 'test', ], 'Description' => [ 'description' => '备注信息。', 'type' => 'string', 'example' => '测试使用', ], 'AccountType' => [ 'description' => '数据库账号的类型，取值说明：'."\n" .'- **1**：普通账号。'."\n" .'- **6**：高权限账号。', 'type' => 'string', 'example' => '1', ], 'Status' => [ 'description' => '账号状态。取值说明：'."\n" ."\n" .'- **0**：创建中。'."\n" ."\n" .'- **1**：使用中。'."\n" ."\n" .'- **3**：删除中。', 'type' => 'string', 'example' => '1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Accounts\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"AccountType\\": \\"1\\",\\n \\"Status\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询账号列表', ], 'DescribeAccountAuthority' => [ 'summary' => '调用DescribeAccountAuthority接口查看账号权限。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185309', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'Account', 'in' => 'query', 'schema' => [ 'description' => '数据库账号的名称。', 'type' => 'string', 'required' => true, 'example' => 'test1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC911****', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Account' => [ 'description' => '数据库账号的名称。', 'type' => 'string', 'example' => 'test1', ], 'DmlAuthority' => [ 'description' => '是否授予数据库账号DML权限。取值如下：'."\n" ."\n" .'- 0：Read，Write，and Change settings queries are allowed.'."\n" .'- 1：Only Read data queries are allowed.'."\n" ."\n" .'- 2：Read data and Change settings queries are allowed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'DdlAuthority' => [ 'description' => '是否授予数据库账号DDL权限，取值说明：'."\n" ."\n" .'- **true**：允许DDL。'."\n" .'- **false**：禁止DDL。'."\n", 'type' => 'boolean', 'example' => 'true', ], 'AllowDatabases' => [ 'description' => '已授权的数据库列表。', 'type' => 'array', 'items' => [ 'description' => '已授权的数据库列表。', 'type' => 'string', 'example' => 'db1', ], ], 'AllowDictionaries' => [ 'description' => '已授权的字典列表。', 'type' => 'array', 'items' => [ 'description' => '已授权的字典列表。', 'type' => 'string', 'example' => 'dt1', ], ], 'TotalDatabases' => [ 'description' => '所有数据库列表。', 'type' => 'array', 'items' => [ 'description' => '所有数据库列表。', 'type' => 'string', 'example' => 'db1,db2', ], ], 'TotalDictionaries' => [ 'description' => '数据库。', 'type' => 'array', 'items' => [ 'description' => 'db.dict形式，代表某数据库的某字典', 'type' => 'string', 'example' => 'test1.range_key_dict', ], ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], [ 'errorCode' => 'InvalidAccountName.NotFound', 'errorMessage' => 'Specified account name does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC911****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\",\\n \\"DmlAuthority\\": 0,\\n \\"DdlAuthority\\": true,\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"test1.range_key_dict\\"\\n ]\\n }\\n}","type":"json"}]', 'title' => '查看账号权限', ], 'CreateDB' => [ 'summary' => '调用CreateDB接口创建数据库。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185311', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。命名规则如下：'."\n" .'- 由小写字母、数字、下划线（_）、中划线（-）组成。'."\n" .'- 以小写字母开头，且以小写字母或数字结尾。'."\n" .'- 长度最多为64个字符。'."\n" ."\n" .'>下划线（_）会被看作两个字符。>', 'type' => 'string', 'required' => true, 'example' => 'testdb001', ], ], [ 'name' => 'Comment', 'in' => 'query', 'schema' => [ 'description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'DBName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb001', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', 'title' => '创建数据库', ], 'DeleteDB' => [ 'summary' => '调用DeleteDB接口删除数据库。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185312', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '目标数据库名称。', 'type' => 'string', 'required' => true, 'example' => 'testdb001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'DBName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'testdb001', ], ], ], ], ], ], ], 'errorCodes' => [ 403 => [ [ 'errorCode' => 'InvalidDBInstanceState.NotSupport', 'errorMessage' => 'The specified instance state does\'t support this operation.', ], ], [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', 'title' => '删除数据库', ], 'DescribeDBInstanceDataSources' => [ 'summary' => '调用DescribeDBInstanceDataSources接口查询DB或者Table的数据结构。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185313', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'DBName', 'in' => 'query', 'schema' => [ 'description' => '数据库名称。', 'type' => 'string', 'required' => false, 'example' => 'dbtest', ], ], [ 'name' => 'TableName', 'in' => 'query', 'schema' => [ 'description' => '表名称。', 'type' => 'string', 'required' => false, 'example' => 'tableTest', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F543E6CC-6868-523D-8D28-0E92CF977ED2', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Schemas' => [ 'description' => '账号。', 'type' => 'string', 'example' => 'default', ], 'Tables' => [ 'description' => '表列表。', 'type' => 'array', 'items' => [ 'description' => '表列表。', 'type' => 'string', 'example' => 'table_test', ], ], 'Columns' => [ 'description' => '列类型。', 'type' => 'array', 'items' => [ 'description' => '列类型。', 'type' => 'object', 'properties' => [ 'DBName' => [ 'description' => '数据库名称。', 'type' => 'string', 'example' => 'dbtest', ], 'Type' => [ 'description' => '存储数据类型。', 'type' => 'string', 'example' => 'UInt64', ], 'TableName' => [ 'description' => '表名。', 'type' => 'string', 'example' => 'tableTest', ], 'ColumnName' => [ 'description' => '列名。', 'type' => 'string', 'example' => 'c31', ], 'PrimaryKey' => [ 'description' => '列是否为主键，取值说明：'."\n" ."\n" .'- **true**：主键。'."\n" .'- **false**：非主键。', 'type' => 'string', 'example' => 'false', ], 'Comment' => [ 'description' => '数据库账号的描述。', 'type' => 'string', 'example' => '测试', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound ', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F543E6CC-6868-523D-8D28-0E92CF977ED2\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Schemas\\": \\"default\\",\\n \\"Tables\\": [\\n \\"table_test\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"DBName\\": \\"dbtest\\",\\n \\"Type\\": \\"UInt64\\",\\n \\"TableName\\": \\"tableTest\\",\\n \\"ColumnName\\": \\"c31\\",\\n \\"PrimaryKey\\": \\"false\\",\\n \\"Comment\\": \\"测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询DB或者Table的数据结构', ], 'CreateEndpoint' => [ 'summary' => '调用CreateEndpoint接口申请外网地址。', 'methods' => [ 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185384', 'abilityTreeNodes' => [ 'FEATUREclickhouseZHDS8I', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ 'description' => '网络类型。', 'type' => 'string', 'required' => false, 'example' => 'Public', 'enum' => [ 'Public', ], ], ], [ 'name' => 'ConnectionPrefix', 'in' => 'query', 'schema' => [ 'description' => '目标连接地址的前缀。'."\n" .'即ConnectionString参数的前缀部分。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', 'title' => '申请外网地址', ], 'DeleteEndpoint' => [ 'summary' => '调用DeleteEndpoint接口释放外网地址。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185385', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '目标集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'description' => '目标连接地址的前缀，即ConnectionString参数的前缀部分。', 'type' => 'string', 'required' => false, 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', ], ], [ 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', 'title' => '释放外网地址', ], 'ModifyDBInstanceConnectionString' => [ 'summary' => '调用ModifyDBInstanceConnectionString接口修改集群的连接地址。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'high', 'chargeType' => 'free', 'abilityTreeCode' => '186649', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', ], ], [ 'name' => 'ConnectionString', 'in' => 'query', 'schema' => [ 'description' => '连接地址。', 'type' => 'string', 'required' => false, 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', ], ], [ 'name' => 'ConnectionStringPrefix', 'in' => 'query', 'schema' => [ 'description' => '连接数据库的地址前辍。', 'type' => 'string', 'required' => false, 'example' => 'cc-****-clickhouse', ], ], [ 'name' => 'DisablePorts', 'in' => 'query', 'schema' => [ 'description' => '- 禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。'."\n" .'- 仅内核版本大于等于24.10.1.11098_1的集群支持此参数。'."\n" .'>集群创建时其版本低于24.10.1.11098_1，后期升级到24.10.1.11098_1版本及以上的版本，不支持此参数。', 'type' => 'string', 'required' => false, 'example' => '9001,8123', ], ], [ 'name' => 'DBInstanceNetType', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, 'enum' => [ 'Public', ], ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxxx', ], 'ConnectionString' => [ 'description' => '连接地址。', 'type' => 'string', 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => 'cc-xxxxx', ], 'DisabledPorts' => [ 'description' => '已经禁用的数据库端口。', 'type' => 'string', 'example' => '9001,8123', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"ConnectionString\\": \\"cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"cc-xxxxx\\",\\n \\"DisabledPorts\\": \\"9001,8123\\"\\n }\\n}","type":"json"}]', 'title' => '修改连接地址', ], 'ModifySecurityIPList' => [ 'summary' => '调用ModifySecurityIPList接口变更集群白名单设置。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', ], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => [ 'description' => '操作的分组名称。', 'type' => 'string', 'required' => false, 'example' => 'test', ], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => [ 'description' => '白名单IP地址。', 'type' => 'string', 'required' => false, 'example' => '192.168.0.0/24,172.16.0.0/24', ], ], [ 'name' => 'ModifyMode', 'in' => 'query', 'schema' => [ 'description' => '修改模式。'."\n" .'- 0：覆盖修改'."\n" .'- 1：增加'."\n" .'- 2：删除'."\n" ."\n" .'> 建议固定指定0进行覆盖修改', 'type' => 'string', 'required' => false, 'example' => '0', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'GroupName' => [ 'description' => '分组名称。', 'type' => 'string', 'example' => 'test', ], 'SecurityIPType' => [ 'description' => 'IP地址类型。', 'type' => 'string', 'example' => 'ipv4', ], 'GroupTag' => [ 'description' => '分组标签。', 'type' => 'string', 'example' => 'test', ], 'TaskId' => [ 'description' => '任务ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'SecurityIPList' => [ 'description' => '白名单分组下的IP列表。', 'type' => 'string', 'example' => '192.168.0.0/24,172.16.0.0/24', ], 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxx', ], 'WhitelistNetType' => [ 'description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => 'cc-xxxx', ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"TaskId\\": 1,\\n \\"SecurityIPList\\": \\"192.168.0.0/24,172.16.0.0/24\\",\\n \\"DBInstanceID\\": 0,\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"cc-xxxx\\"\\n }\\n}","type":"json"}]', 'title' => '变更白名单', ], 'DescribeSecurityIPList' => [ 'summary' => '调用DescribeSecurityIPList接口查询白名单。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '185650', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z3****', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => '集群测试', ], 'GroupItems' => [ 'description' => '白名单分组列表。', 'type' => 'array', 'items' => [ 'description' => '白名单分组列表。', 'type' => 'object', 'properties' => [ 'GroupName' => [ 'description' => '白名单分组名称。', 'type' => 'string', 'example' => 'default', ], 'SecurityIPType' => [ 'description' => 'IP地址的类型。', 'type' => 'string', 'example' => 'ipv4', ], 'GroupTag' => [ 'description' => '分组标签。', 'type' => 'string', 'example' => 'test', ], 'SecurityIPList' => [ 'description' => '白名单分组下的IP列表。', 'type' => 'string', 'example' => '127.0.XX.XX', ], 'WhitelistNetType' => [ 'description' => '白名单的网络类型。', 'type' => 'string', 'example' => 'mix', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询白名单', ], 'DescribeEndpoints' => [ 'summary' => '调用DescribeEndpoints接口查询集群的访问地址。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185373', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'title' => '计算组ID。', 'description' => '计算组ID。', 'type' => 'string', 'required' => false, 'example' => 'cc-*****-clickhouse', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'InstanceNetworkType' => [ 'description' => '实例的网络类型，取值：'."\n" .'* **VPC**：专有网络。'."\n" .'* **PUBLIC**：公网网络。', 'type' => 'string', 'example' => 'VPC', ], 'Endpoints' => [ 'description' => 'Endpoint详细信息列表。', 'type' => 'array', 'items' => [ 'description' => 'Endpoint详细信息。', 'type' => 'object', 'properties' => [ 'NetType' => [ 'description' => '连接地址的网络类型，取值：'."\n" .'- VPC：专有网络。'."\n" .'- PUBLIC：公网网络。', 'type' => 'string', 'example' => 'VPC', ], 'Status' => [ 'description' => '状态。', 'type' => 'string', 'example' => 'active', ], 'ConnectionString' => [ 'description' => '实例连接地址', 'type' => 'string', 'example' => 'cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com', ], 'VpcId' => [ 'description' => 'VPC ID。', 'type' => 'string', 'example' => 'vpc-uf61z****', ], 'VSwitchId' => [ 'description' => '交换机ID。', 'type' => 'string', 'example' => 'vsw-0xi8829****', ], 'VpcInstanceId' => [ 'description' => 'VPC实例ID。', 'type' => 'string', 'example' => 'vpc-uf61z****', ], 'Ports' => [ 'description' => '端口详细信息列表。', 'type' => 'array', 'items' => [ 'description' => '端口详细信息。', 'type' => 'object', 'properties' => [ 'Protocol' => [ 'description' => '协议类型。取值范围：'."\n" ."\n" .'- HttpPort：HTTP端口号。'."\n" .'- HttpsPort：HTTPS端口号。'."\n" .'- TcpPort：TCP端口号。', 'type' => 'string', 'example' => 'HttpPort', ], 'Port' => [ 'description' => '访问端口。取值范围：'."\n" ."\n" .'- HttpPort：8123'."\n" .'- HttpsPort：8443'."\n" .'- TcpPort：9000', 'type' => 'integer', 'format' => 'int32', 'example' => '8123', ], ], ], ], 'IPAddress' => [ 'description' => 'IP地址。', 'type' => 'string', 'example' => '172.30.XX.XX', ], 'ComputingGroupId' => [ 'title' => '计算组id', 'description' => '计算组id', 'type' => 'string', 'example' => 'cc-ad321**-clickhouse', ], 'EndpointName' => [ 'title' => '连接串名称', 'description' => '连接串名称', 'type' => 'string', 'example' => 'cc-*****-clickhouse', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 404 => [ [ 'errorCode' => 'InvalidDBInstanceId.NotFound', 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"Status\\": \\"active\\",\\n \\"ConnectionString\\": \\"cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"VpcInstanceId\\": \\"vpc-uf61z****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"HttpPort\\",\\n \\"Port\\": 8123\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.XX.XX\\",\\n \\"ComputingGroupId\\": \\"cc-ad321**-clickhouse\\",\\n \\"EndpointName\\": \\"cc-*****-clickhouse\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询集群访问地址', ], 'DescribeProcessList' => [ 'summary' => '调用DescribeProcessList接口查看正在运行中的查询。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '186631', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', ], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', 'schema' => [ 'description' => '慢SQL的执行耗时，单位ms，最小1000 ms。', 'type' => 'string', 'required' => false, 'example' => '1000', ], ], [ 'name' => 'InitialUser', 'in' => 'query', 'schema' => [ 'description' => '查询用户。', 'type' => 'string', 'required' => false, 'example' => 'testuser', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => [ 'description' => '查询语句的关键字。', 'type' => 'string', 'required' => false, 'example' => 'SELECT', ], ], [ 'name' => 'InitialQueryId', 'in' => 'query', 'schema' => [ 'description' => '查询ID。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'QueryOrder', 'in' => 'query', 'schema' => [ 'description' => '按指定列倒序排序。'."\n" ."\n" .'- 0表示仅用query_duration_ms排序'."\n" ."\n" .'- 1表示用query_duration_ms、query_start_time排序'."\n" ."\n" .'- 2表示用query_duration_ms、query_start_time、user排序', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], 'Data' => [ 'description' => '返回的结果。', 'type' => 'object', 'properties' => [ 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxx', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => '测试使用', ], 'TotalCount' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ResultSet' => [ 'description' => '结果集。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InitialQueryId' => [ 'description' => '查询ID。', 'type' => 'string', 'example' => '\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'', ], 'QueryStartTime' => [ 'description' => '查询开始时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。', 'type' => 'string', 'example' => '2023-07-23T10:13:23Z', ], 'InitialAddress' => [ 'description' => '查询地址。', 'type' => 'string', 'example' => '0:0:0:0:0:ffff:1edd65ea', ], 'Query' => [ 'description' => '正在查询的语句。', 'type' => 'string', 'example' => 'select * from test', ], 'InitialUser' => [ 'description' => '查询用户。', 'type' => 'string', 'example' => 'bany', ], 'QueryDurationMs' => [ 'description' => '最短的查询耗时。最小值为**1000**。单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"测试使用\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"InitialQueryId\\": \\"\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'\\",\\n \\"QueryStartTime\\": \\"2023-07-23T10:13:23Z\\",\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查看正在运行中的查询', ], 'KillProcess' => [ 'summary' => '调用KillProcess接口终止正在进行的任务。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '186648', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxxxx', ], ], [ 'name' => 'InitialQueryId', 'in' => 'query', 'schema' => [ 'description' => '查询ID。', 'type' => 'string', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回参数详情。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'xxx-xxx-xxx', ], 'Data' => [ 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-xxxxxxx', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => 'cc-xxxxxxx'."\n", ], 'Count' => [ 'description' => '结束任务数量。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"Count\\": 1\\n }\\n}","type":"json"}]', 'title' => '终止正在进行的任务', ], 'DescribeSlowLogTrend' => [ 'summary' => '调用DescribeSlowLogTrend接口查询慢日志趋势。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '186604', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-04-13 17:48:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-06-07 10:03:00', ], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', 'schema' => [ 'description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', 'type' => 'string', 'required' => false, 'example' => '3000', ], ], [ 'name' => 'Product', 'in' => 'query', 'schema' => [ 'description' => '产品code。', 'type' => 'string', 'required' => false, 'example' => 'clickhouse', 'default' => 'clickhouse', ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z3****', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => '集群测试', ], 'ResultSet' => [ 'description' => '结果集。', 'type' => 'array', 'items' => [ 'description' => '结果集。', 'type' => 'object', 'properties' => [ 'QueryStartTime' => [ 'description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'example' => '2023-04-13 17:48:00', ], 'MaxQueryDurationMs' => [ 'description' => '慢SQL执行的最大耗时，单位：ms，最小值为**1000**。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', ], 'Cnt' => [ 'description' => '当前时间内SQL总和。', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'MinQueryDurationMs' => [ 'description' => '慢SQL执行的最小耗时，单位：ms，最小值为**1000**。', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', ], 'AvgQueryDurationMs' => [ 'description' => '慢SQL执行的平均耗时，单位：ms，最小值为**1000**。', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-04-13 17:48:00\\",\\n \\"MaxQueryDurationMs\\": 3000,\\n \\"Cnt\\": 1,\\n \\"MinQueryDurationMs\\": 1000,\\n \\"AvgQueryDurationMs\\": 2000\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询慢日志趋势', ], 'DescribeSlowLogRecords' => [ 'summary' => '调用DescribeSlowLogRecords接口查询慢日志明细。', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '186629', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-09-11 16:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'required' => false, 'example' => '2023-09-15 16:00:00', ], ], [ 'name' => 'QueryDurationMs', 'in' => 'query', 'schema' => [ 'description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', 'type' => 'string', 'required' => false, 'example' => '3000', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数，取值：'."\n" .'- 30（默认值）'."\n" .'- 50'."\n" .'- 100', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', ], ], [ 'name' => 'ComputingGroupId', 'in' => 'query', 'schema' => [ 'type' => 'string', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A', ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceID' => [ 'description' => '集群ID。', 'type' => 'integer', 'format' => 'int32', 'example' => 'cc-bp100p4q1g9z32****', ], 'DBInstanceName' => [ 'description' => '集群名称。', 'type' => 'string', 'example' => '集群测试', ], 'TotalCount' => [ 'description' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'ResultSet' => [ 'description' => '结果集。', 'type' => 'array', 'items' => [ 'description' => '结果集。', 'type' => 'object', 'properties' => [ 'QueryStartTime' => [ 'description' => '查询开始的时间。格式：yyyy-MM-dd hh:mm:ss（UTC时间）。', 'type' => 'string', 'example' => '2023-09-11 16:00:00', ], 'InitialQueryId' => [ 'description' => '查询ID。', 'type' => 'string', 'example' => '\'ae915a3ad30e77e67a7215d05b658cc6\'', ], 'ReadRows' => [ 'description' => '读取行数。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], 'InitialAddress' => [ 'description' => '查询地址。', 'type' => 'string', 'example' => '0:0:0:0:0:ffff:1edd65ea', ], 'Query' => [ 'description' => '正在查询的语句。', 'type' => 'string', 'example' => 'select * from test', ], 'MemoryUsage' => [ 'description' => '查询内存使用峰值。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '4941696', ], 'Type' => [ 'description' => '慢日志类型。', 'type' => 'string', 'example' => 'ExceptionWhileProcessing', ], 'ReadBytes' => [ 'description' => '扫描数据大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '4507128020832', ], 'InitialUser' => [ 'description' => '查询用户。', 'type' => 'string', 'example' => 'bany', ], 'QueryDurationMs' => [ 'description' => '慢SQL的执行耗时。最小值为**1000**，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', ], 'ResultBytes' => [ 'description' => '结果数据大小。单位：Byte。', 'type' => 'integer', 'format' => 'int64', 'example' => '10', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-09-11 16:00:00\\",\\n \\"InitialQueryId\\": \\"\'ae915a3ad30e77e67a7215d05b658cc6\'\\",\\n \\"ReadRows\\": 10,\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"MemoryUsage\\": 4941696,\\n \\"Type\\": \\"ExceptionWhileProcessing\\",\\n \\"ReadBytes\\": 4507128020832,\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 3000,\\n \\"ResultBytes\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询慢日志明细', ], 'ModifyBackupPolicy' => [ 'summary' => '修改ClickHouse企业版集群的备份策略。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206399', 'abilityTreeNodes' => [ 'FEATUREclickhouseIL81EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => [ 'description' => '备份时间。', 'type' => 'string', 'required' => true, 'example' => '15:00Z-16:00Z', ], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => [ 'description' => '备份周期。', 'type' => 'string', 'required' => true, 'example' => 'Monday', ], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => '备份保留天数。', 'type' => 'string', 'required' => false, 'example' => '7', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', 'title' => '修改备份策略', 'description' => '>版本为20.3、20.8和21.8的云数据库ClickHouse集群支持数据备份。', ], 'DescribeBackupPolicy' => [ 'summary' => '查看ClickHouse企业版集群的备份策略', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206399', 'abilityTreeNodes' => [ 'FEATUREclickhouseIL81EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp100p4q1g9z3****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'PreferredBackupPeriod' => [ 'description' => '备份周期。'."\n" .'取值如下：'."\n" ."\n" .'- **Monday**：周一。'."\n" .'- **Tuesday**：周二。'."\n" .'- **Wednesday**：周三。'."\n" .'- **Thursday**：周四。'."\n" .'- **Friday**：周五。'."\n" .'- **Saturday**：周六。'."\n" .'- **Sunday**：周日。', 'type' => 'string', 'example' => 'Monday', ], 'Switch' => [ 'description' => '是否开启备份。'."\n" .'取值如下：'."\n" ."\n" .'- **true**：已开启。'."\n" .'- **false**：未开启。', 'type' => 'string', 'example' => 'true', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', ], 'PreferredBackupTime' => [ 'description' => '备份时间，UTC 时间。', 'type' => 'string', 'example' => '15:00Z-16:00Z', ], 'BackupRetentionPeriod' => [ 'description' => '备份保留天数。', 'type' => 'integer', 'format' => 'int32', 'example' => '7', ], 'BackupSize' => [ 'description' => '备份文件大小。'."\n" .'单位：MB。', 'type' => 'string', 'example' => '123124', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","type":"json"}]', 'title' => '查看备份策略', ], 'DeleteBackupPolicy' => [ 'summary' => '删除ClickHouse企业版集群的备份策略。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206399', 'abilityTreeNodes' => [ 'FEATUREclickhouseN8BUWF', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-xxxxx', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '60DDD29D-E5A8-563C-88FB-06D3A1F1C609', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60DDD29D-E5A8-563C-88FB-06D3A1F1C609\\"\\n}","type":"json"}]', 'title' => '删除备份策略', ], 'CreateBackupPolicy' => [ 'summary' => '为指定的ClickHouse企业版集群创建备份策略。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206399', 'abilityTreeNodes' => [ 'FEATUREclickhouseIL81EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-2ze0eb0w182xh8549', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'PreferredBackupTime', 'in' => 'query', 'schema' => [ 'description' => '执行备份的`UTC`时间范围。'."\n" .'例如`12:00Z-13:00Z`，则表示将在`UTC`时间的`12:00`到`13:00`之间开始执行备份。', 'type' => 'string', 'required' => true, 'example' => '10:00Z-11:00Z', ], ], [ 'name' => 'PreferredBackupPeriod', 'in' => 'query', 'schema' => [ 'description' => '备份周期。'."\n" .'指定每周备份日期，多个日期需用英文逗号`,`隔开。', 'type' => 'string', 'required' => true, 'example' => 'Monday,Friday', ], ], [ 'name' => 'BackupRetentionPeriod', 'in' => 'query', 'schema' => [ 'description' => '备份保留天数。', 'type' => 'string', 'required' => false, 'example' => '8', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', 'title' => '创建备份策略', ], 'DescribeBackups' => [ 'summary' => '查询ClickHouse企业版集群的备份集。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206399', 'abilityTreeNodes' => [ 'FEATUREclickhouseIL81EM', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '集群ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1v9kq45u0o80cvh', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。您可以通过调用[DescribeRegions](~~170875~~)接口查询地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-beijing', ], ], [ 'name' => 'BackupId', 'in' => 'query', 'schema' => [ 'description' => '备份记录ID。', 'type' => 'string', 'required' => false, 'example' => '117403****', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '备份开始时间，UTC时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-21T16:00Z', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '备份结束时间，UTC时间。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-11-25T16:00Z', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '30', 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'description' => '备份总个数。', 'type' => 'string', 'example' => '1', ], 'PageSize' => [ 'description' => '每页记录数。', 'type' => 'string', 'example' => '30', ], 'RequestId' => [ 'description' => '请求ID。', 'type' => 'string', 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', ], 'PageNumber' => [ 'description' => '页码。', 'type' => 'string', 'example' => '1', ], 'Items' => [ 'description' => '备份集列表。', 'type' => 'array', 'items' => [ 'description' => '备份集列表。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '集群ID。', 'type' => 'string', 'example' => 'cc-bp179i5956tih2m93', ], 'BackupStatus' => [ 'description' => '备份集状态。', 'type' => 'string', 'example' => 'Success', ], 'BackupType' => [ 'description' => '备份类型。'."\n" .'取值如下：'."\n" ."\n" .'- **FullBackup**：全量备份。'."\n" .'- **IncrementalBackup**：增量备份。', 'type' => 'string', 'example' => 'IncrementalBackup', ], 'BackupStartTime' => [ 'description' => '备份开始时间。', 'type' => 'string', 'example' => '2021-11-22T18:28:22Z', ], 'BackupSize' => [ 'description' => '备份文件大小，单位MB。', 'type' => 'integer', 'format' => 'int64', 'example' => '131072', ], 'BackupEndTime' => [ 'description' => '本次备份结束时间，UTC时间。', 'type' => 'string', 'example' => '2021-11-22T18:28:41Z', ], 'BackupSetInfo' => [ 'description' => '备份集信息。', 'type' => 'string', 'example' => '{"shard_count": 4}', ], 'BackupId' => [ 'description' => '备份记录ID。', 'type' => 'string', 'example' => '117403****', ], 'BackupMethod' => [ 'description' => '备份方法。', 'type' => 'string', 'example' => 'Physical', ], 'ExpireDate' => [ 'description' => '备份集过期时间。', 'type' => 'string', 'example' => '2022-07-22T18:28:41Z', ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-bp179i5956tih2m93\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '查看备份集', ], 'ModifyDBInstanceConfig' => [ 'summary' => '修改实例参数配置', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '206399', 'abilityTreeNodes' => [ 'FEATUREclickhouseFBPCH8', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-uf6lkzf*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'Parameters', 'in' => 'query', 'schema' => [ 'description' => 'JSON格式的API数据参数配置。', 'type' => 'string', 'required' => false, 'example' => '{"max_concurrent_queries":"100"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05321590-BB65-4720-8C***********', ], 'Data' => [ 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'cc-uf6lkzf*****'."\n", ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8C***********\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-uf6lkzf*****\\\\n\\"\\n }\\n}","type":"json"}]', 'title' => '修改实例配置', ], 'DescribeDBInstanceConfigChangeLog' => [ 'summary' => '查询实例参数配置记录', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '206401', 'abilityTreeNodes' => [ 'FEATUREclickhouseFBPCH8', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-uf6lkzf*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-shanghai', ], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => [ 'description' => '查询开始时间。格式：yyyy-MM-dd hh:mm:ss 。', 'type' => 'string', 'required' => true, 'example' => '2025-01-01 10:00:00', ], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => [ 'description' => '查询结束时间。格式：yyyy-MM-dd hh:mm:ss 。', 'type' => 'string', 'required' => true, 'example' => '2025-01-01 10:00:00'."\n", ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数，取值：'."\n" .'- **30**（默认值）'."\n" .'- **50**'."\n" .'- **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '30', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '780DE414-*********-88BE-A2E21B862B57', ], 'Data' => [ 'description' => '查询结果集。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'ParamChangeLogs' => [ 'description' => '参数变更记录。', 'type' => 'array', 'items' => [ 'description' => '参数变更记录。', 'type' => 'object', 'properties' => [ 'ID' => [ 'description' => '操作ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', ], 'Name' => [ 'description' => '参数名称。', 'type' => 'string', 'example' => 'max_concurrent_queries', ], 'OldValue' => [ 'description' => ' '."\n" .'旧参数值。', 'type' => 'string', 'example' => '50', ], 'NewValue' => [ 'description' => ' '."\n" .'新参数值。', 'type' => 'string', 'example' => '100', ], 'Applied' => [ 'description' => '配置是否生效：'."\n" ."\n" .'- true：生效'."\n" ."\n" .'- false：不生效', 'type' => 'boolean', ], 'GmtCreated' => [ 'description' => '变更创建时间。', 'type' => 'string', 'example' => '2025-06-25 13:46:06', ], 'GmtModified' => [ 'description' => '变更修改时间。', 'type' => 'string', 'example' => '2025-06-25 13:46:06'."\n", ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"780DE414-*********-88BE-A2E21B862B57\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"ParamChangeLogs\\": [\\n {\\n \\"ID\\": 1,\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"OldValue\\": \\"50\\",\\n \\"NewValue\\": \\"100\\",\\n \\"Applied\\": true,\\n \\"GmtCreated\\": \\"2025-06-25 13:46:06\\",\\n \\"GmtModified\\": \\"2025-06-25 13:46:06\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询实例参数变更记录', ], 'DescribeDBInstanceConfig' => [ 'summary' => '查询实例参数配置', 'methods' => [ 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '204414', 'abilityTreeNodes' => [ 'FEATUREclickhouseFBPCH8', ], ], 'parameters' => [ [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'description' => '实例ID。', 'type' => 'string', 'required' => true, 'example' => 'cc-wz9go4x*****', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'description' => '地域ID。', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n", ], 'Data' => [ 'description' => '返回结果。', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'description' => '实例ID。', 'type' => 'string', 'example' => 'cc-bp100p4q1g9z3****', ], 'Params' => [ 'description' => '用户参数。', 'type' => 'array', 'items' => [ 'description' => '用户参数。', 'type' => 'object', 'properties' => [ 'IsDynamic' => [ 'description' => '是否动态生效（不需要重启）。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'IsUserModifiable' => [ 'description' => '用户是否可修改。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'DefaultValue' => [ 'description' => '参数默认值。', 'type' => 'string', 'example' => '1', ], 'Name' => [ 'description' => '参数名。', 'type' => 'string', 'example' => 'max_concurrent_queries', ], 'Optional' => [ 'description' => '参数取值范围。', 'type' => 'string', 'example' => '[0-100]', ], 'Comment' => [ 'description' => '参数备注信息。', 'type' => 'string', 'example' => 'Maximum number of concurrently executed queries. Zero means unlimited.', ], 'ParamRelyRule' => [ 'description' => '参数依赖。', 'type' => 'string', 'example' => '0', ], 'Value' => [ 'description' => '参数值。', 'type' => 'string', 'example' => '100', ], ], ], ], ], ], ], ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Params\\": [\\n {\\n \\"IsDynamic\\": 1,\\n \\"IsUserModifiable\\": 1,\\n \\"DefaultValue\\": \\"1\\",\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"Optional\\": \\"[0-100]\\",\\n \\"Comment\\": \\"Maximum number of concurrently executed queries. Zero means unlimited.\\",\\n \\"ParamRelyRule\\": \\"0\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '查询实例参数配置', ], 'ChangeResourceGroup' => [ 'summary' => '修改ClickHouse企业版实例所在资源组。', 'methods' => [ 'post', ], 'schemes' => [ 'http', 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '163948', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ 'title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'required' => false, 'enumValueTitles' => [], 'example' => 'EnterpriseDBCluster', 'default' => 'EnterpriseDBCluster', ], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => [ 'title' => '资源Id', 'description' => '资源Id', 'type' => 'string', 'required' => true, 'example' => 'cc-bp1i43033051****', ], ], [ 'name' => 'ResourceRegionId', 'in' => 'query', 'schema' => [ 'title' => '地域Id', 'description' => '地域Id', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => [ 'title' => '目标资源组', 'description' => '目标资源组', 'type' => 'string', 'required' => true, 'example' => 'rg-4690g37929****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'C342F3DD-1FF7-55E9-A1A1-098D*******', ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', ], [ 'errorCode' => 'MissingParameter.ResourceRegionId', 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', ], [ 'errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', ], [ 'errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', ], [ 'errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', ], [ 'errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', ], [ 'errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', ], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098D*******\\"\\n}","type":"json"}]', 'title' => '修改ClickHouse企业版实例所在资源组', ], 'ListClickHouseDBTimezones' => [ 'summary' => '列举ClickHouse时区参数枚举值', 'path' => '', 'methods' => [ 'get', 'post', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => [ 'FEATUREclickhouseFBPCH8', ], ], 'parameters' => [ [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'description' => '每页记录数，取值：'."\n" .'- **30**（默认值）'."\n" .'- **50**'."\n" .'- **100**'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'default' => '10', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'description' => '页数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', ], 'TimeZones' => [ 'description' => 'ClickHouse支持的时区枚举值列表。', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ZoneId' => [ 'description' => '时区枚举值。', 'type' => 'string', 'example' => 'Asia/Shanghai', ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"TimeZones\\": [\\n {\\n \\"ZoneId\\": \\"Asia/Shanghai\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => '获取ClickHouse时区枚举值列表', ], 'DeleteWhitelistTemplate' => [ 'summary' => '删除白名单模板', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', ], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => [ 'title' => '白名单模板Id', 'type' => 'string', 'example' => '98a6d3db05984dca', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Templates' => [ 'title' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], 'DbInstances' => [ 'title' => '关联的实例列表', 'type' => 'array', 'items' => [ 'title' => '实例详情', 'type' => 'object', 'properties' => [ 'DbInstanceName' => [ 'title' => '实例ID', 'type' => 'string', 'example' => 'asdfwef', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', ], [ 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '', ], 'CreateWhitelistTemplate' => [ 'summary' => '新增白名单模板', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => [ 'title' => '白名单模板名称', 'description' => '白名单模板名称', 'type' => 'string', 'required' => true, 'example' => 'InvoiceTemplate', ], ], [ 'name' => 'SecurityIPList', 'in' => 'formData', 'schema' => [ 'title' => '白名单列表. 逗号分隔，数量不超过100个。', 'description' => '白名单列表。基于逗号分隔，数量不超过100个。', 'type' => 'string', 'required' => true, 'example' => '192.168.1.1,10.0.0.1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '', 'description' => '返回数据', 'type' => 'object', 'properties' => [ 'Templates' => [ 'title' => '白名单模板列表', 'description' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'description' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'TemplateName' => [ 'title' => '白名单模板名称', 'description' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'description' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'Specified IPList is not valid.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidWhitelistTemplateName.Duplicated', 'errorMessage' => 'Whitelist template name duplicated.', ], [ 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', ], [ 'errorCode' => 'InvalidSecurityIPList.Format', 'errorMessage' => 'Specified security IP list format is not valid.', ], [ 'errorCode' => 'InvalidWhitelistTemplateName.CreateLimit', 'errorMessage' => 'Created Whitelist template name exceeded limit.', ], [ 'errorCode' => 'InvalidIpWhitelistTemplateName.Malformed', 'errorMessage' => 'The templateName is not valid.', ], [ 'errorCode' => 'InvalidSecurityIPList.Duplicate', 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', ], [ 'errorCode' => 'InvalidUser.NotFound', 'errorMessage' => 'Specified user does not exist.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '创建白名单模板', ], 'DetachWhitelistTemplateToInstance' => [ 'summary' => '取消白名单模板和实例关联关系', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'title' => '数据库实例名。逗号分隔，一次关联变更不超过20个', 'type' => 'string', 'required' => true, 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '操作状态。ok', 'type' => 'string', 'example' => 'ok', ], 'DetachFailList' => [ 'title' => '解绑失败实例', 'type' => 'array', 'items' => [ 'title' => '实例解绑失败详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例名称', 'type' => 'string', 'example' => 'my-database', ], 'Reason' => [ 'title' => '解绑失败原因', 'type' => 'string', 'example' => '处理异常', ], ], ], ], 'DetachSuccessedList' => [ 'title' => '绑定成功模板', 'type' => 'array', 'items' => [ 'title' => '实例绑定成功详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例名称', 'type' => 'string', 'example' => 'my-database', ], 'Templates' => [ 'title' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'TemplateName' => [ 'title' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], 'DbInstances' => [ 'title' => '关联的实例列表', 'type' => 'array', 'items' => [ 'title' => '实例详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例ID', 'type' => 'string', 'example' => 'asdfwef', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', ], [ 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', ], [ 'errorCode' => 'InvalidDBInstanceId.TooManyItems', 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', ], [ 'errorCode' => 'InvalidParameter.DBInstanceId', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], ], 'UpdateWhitelistTemplate' => [ 'summary' => '更新白名单模板', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', ], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => [ 'title' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', ], ], [ 'name' => 'SecurityIPList', 'in' => 'query', 'schema' => [ 'title' => '白名单列表. 逗号分隔，数量不超过100个。', 'type' => 'string', 'required' => true, 'example' => '192.168.1.1,10.0.0.1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Templates' => [ 'title' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], 'DbInstances' => [ 'title' => '关联的实例列表', 'type' => 'array', 'items' => [ 'title' => '实例详情', 'type' => 'object', 'properties' => [ 'DbInstanceName' => [ 'title' => '实例ID', 'type' => 'string', 'example' => 'asdfwef', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidSecurityIPs.Malformed', 'errorMessage' => 'Specified IPList is not valid.', ], [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', ], [ 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', ], [ 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], ], 'GetWhitelistTemplate' => [ 'summary' => '查询白名单模板详情', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'Templates' => [ 'title' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'TemplateName' => [ 'title' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], 'DbInstances' => [ 'title' => '关联的实例列表', 'type' => 'array', 'items' => [ 'title' => '实例详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例ID', 'type' => 'string', 'example' => 'cc-asdfwef', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', ], [ 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], ], 'AttachWhitelistTemplateToInstance' => [ 'summary' => '白名单模板关联实例。', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'description' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => [ 'title' => '白名单模板Id', 'description' => '白名单模板Id', 'type' => 'string', 'required' => true, 'example' => '98a6d3db05984dca', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'title' => '数据库实例。逗号分隔，一次关联变更不超过20个', 'description' => '数据库实例。逗号分隔，一次关联变更不超过20个', 'type' => 'string', 'required' => true, 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '', 'description' => '返回数据。', 'type' => 'object', 'properties' => [ 'Status' => [ 'title' => '操作状态。ok', 'description' => '操作状态。ok', 'type' => 'string', 'example' => 'ok', ], 'AttachFailList' => [ 'title' => '解绑失败实例', 'description' => '解绑失败实例', 'type' => 'array', 'items' => [ 'title' => '实例解绑失败详情', 'description' => '实例解绑失败详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'my-database', ], 'Reason' => [ 'title' => '解绑失败原因', 'description' => '解绑失败原因', 'type' => 'string', 'example' => '处理异常', ], ], ], ], 'AttachSuccessedList' => [ 'title' => '绑定成功模板', 'description' => '绑定成功模板', 'type' => 'array', 'items' => [ 'title' => '实例绑定成功详情', 'description' => '实例绑定成功详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例名称', 'description' => '实例名称', 'type' => 'string', 'example' => 'my-database', ], 'Templates' => [ 'title' => '白名单模板列表', 'description' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'description' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'description' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'TemplateName' => [ 'title' => '白名单模板名称', 'description' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'description' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], 'DbInstances' => [ 'title' => '关联的实例列表', 'description' => '关联的实例列表', 'type' => 'array', 'items' => [ 'title' => '实例详情', 'description' => '实例详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'asdfwef', ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], [ 'errorCode' => 'InvalidWhitelistTemplateId', 'errorMessage' => 'Invalid Whitelist templateId.', ], [ 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', 'errorMessage' => 'No permission to operate the whitelist template.', ], [ 'errorCode' => 'InvalidDBInstanceId.TooManyItems', 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', ], [ 'errorCode' => 'InvalidParameter.DBInstanceId', 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', ], [ 'errorCode' => 'InvalidAttachTemplate.QuotaExceeded', 'errorMessage' => 'Exceed the upper limit of the template that the instance can bind.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"AttachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"AttachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => '白名单模板关联实例', ], 'ListWhitelistTemplates' => [ 'summary' => '查询白名单模板清单', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => [ 'title' => '模板名称，支持模糊查询', 'type' => 'string', 'example' => 'default', ], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => [ 'title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', ], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => [ 'title' => '每页记录数量', 'type' => 'integer', 'format' => 'int32', 'example' => '25', 'default' => '25', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '白名单模板清单结果', 'type' => 'object', 'properties' => [ 'TotalCount' => [ 'title' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '30', ], 'PageSize' => [ 'title' => '分页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20', ], 'CurrPageNumbers' => [ 'title' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', ], 'TotalPageNumbers' => [ 'title' => '总页码', 'type' => 'integer', 'format' => 'int32', 'example' => '2', ], 'HasPrev' => [ 'title' => '是否有前一页', 'type' => 'boolean', 'example' => 'false', ], 'HasNext' => [ 'title' => '是否有后一页', 'type' => 'boolean', 'example' => 'true', ], 'Templates' => [ 'title' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'TemplateName' => [ 'title' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], 'DbInstances' => [ 'title' => '关联的实例列表', 'type' => 'array', 'items' => [ 'title' => '实例详情', 'type' => 'object', 'properties' => [ 'DBInstanceId' => [ 'title' => '实例ID', 'type' => 'string', 'example' => 'cc-asdfwef', ], ], ], ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], ], 'ListInstanceLinkedWhitelistTemplates' => [ 'summary' => '查询实例关联的白名单模板清单', 'methods' => [ 'post', 'get', ], 'schemes' => [ 'https', ], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '185639', 'abilityTreeNodes' => [ 'FEATUREclickhouseCVENTL', ], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'schema' => [ 'title' => 'RegionId', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', ], ], [ 'name' => 'DBInstanceId', 'in' => 'query', 'schema' => [ 'title' => '实例名称', 'type' => 'string', 'required' => true, 'example' => 'cc-exadfas', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => [ 'title' => 'Id of the request', 'type' => 'string', 'example' => '1234567890', ], 'Data' => [ 'title' => '白名单模板清单结果', 'type' => 'object', 'properties' => [ 'Templates' => [ 'title' => '白名单模板列表', 'type' => 'array', 'items' => [ 'title' => '模板详情', 'type' => 'object', 'properties' => [ 'TemplateId' => [ 'title' => '白名单模板ID', 'type' => 'string', 'example' => 'g-asdfwem', ], 'TemplateName' => [ 'title' => '白名单模板名称', 'type' => 'string', 'example' => 'demo_template', ], 'SecurityIPList' => [ 'title' => 'ip白名单列表', 'type' => 'string', 'example' => '192.168.1.1,10.0.0.1', ], ], ], ], ], ], ], ], ], ], 'errorCodes' => [ 400 => [ [ 'errorCode' => 'InvalidParameter', 'errorMessage' => 'Invalid parameter.', ], ], ], 'staticInfo' => [ 'returnType' => 'synchronous', ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], ], ], 'endpoints' => [ [ 'regionId' => 'cn-qingdao', 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', ], [ 'regionId' => 'cn-beijing', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-zhangjiakou', 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', ], [ 'regionId' => 'cn-huhehaote', 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', ], [ 'regionId' => 'cn-wulanchabu', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen', 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', ], [ 'regionId' => 'cn-guangzhou', 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', ], [ 'regionId' => 'cn-chengdu', 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', ], [ 'regionId' => 'cn-hongkong', 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', ], [ 'regionId' => 'ap-northeast-1', 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-1', 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-3', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-5', 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', ], [ 'regionId' => 'ap-southeast-6', 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', ], [ 'regionId' => 'eu-central-1', 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', ], [ 'regionId' => 'eu-west-1', 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', ], [ 'regionId' => 'us-west-1', 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', ], [ 'regionId' => 'us-east-1', 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', ], [ 'regionId' => 'me-central-1', 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', ], [ 'regionId' => 'me-east-1', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-north-2-gov-1', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-beijing-finance-1', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-shenzhen-finance-1', 'endpoint' => 'clickhouse.aliyuncs.com', ], [ 'regionId' => 'cn-shanghai-finance-1', 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', ], [ 'regionId' => 'cn-hangzhou-finance', 'endpoint' => 'clickhouse.aliyuncs.com', ], ], ];