diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/clickhouse/2023-05-22/api-docs.php | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/clickhouse/2023-05-22/api-docs.php')
| -rw-r--r-- | data/en_us/clickhouse/2023-05-22/api-docs.php | 7837 |
1 files changed, 7837 insertions, 0 deletions
diff --git a/data/en_us/clickhouse/2023-05-22/api-docs.php b/data/en_us/clickhouse/2023-05-22/api-docs.php new file mode 100644 index 0000000..4a7e3cc --- /dev/null +++ b/data/en_us/clickhouse/2023-05-22/api-docs.php @@ -0,0 +1,7837 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'clickhouse', + 'version' => '2023-05-22', + ], + 'directories' => [ + [ + 'id' => 222452, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDBInstance', + 'DeleteDBInstance', + 'StartDBInstance', + 'RestartDBInstance', + 'StopDBInstance', + 'ModifyDBInstanceClass', + 'ModifyDBInstanceAttribute', + 'DescribeDBInstances', + 'DescribeDBInstanceAttribute', + 'UpgradeMinorVersion', + ], + ], + [ + 'id' => 222463, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAccount', + 'DeleteAccount', + 'ResetAccountPassword', + 'ModifyAccountDescription', + 'ModifyAccountAuthority', + 'DescribeAccounts', + 'DescribeAccountAuthority', + ], + ], + [ + 'id' => 222471, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDB', + 'DeleteDB', + 'DescribeDBInstanceDataSources', + ], + ], + [ + 'id' => 222475, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateEndpoint', + 'DeleteEndpoint', + 'ModifyDBInstanceConnectionString', + 'ModifySecurityIPList', + 'DescribeSecurityIPList', + 'DescribeEndpoints', + ], + ], + [ + 'id' => 222482, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DescribeProcessList', + 'KillProcess', + 'DescribeSlowLogTrend', + 'DescribeSlowLogRecords', + ], + ], + [ + 'id' => 222487, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyBackupPolicy', + 'DescribeBackupPolicy', + 'DeleteBackupPolicy', + 'CreateBackupPolicy', + 'DescribeBackups', + ], + ], + [ + 'id' => 222493, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ModifyDBInstanceConfig', + 'DescribeDBInstanceConfigChangeLog', + 'DescribeDBInstanceConfig', + ], + ], + [ + 'id' => 222497, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + ], + ], + [ + 'id' => 0, + 'title' => 'Others', + 'type' => 'directory', + 'children' => [ + 'ListClickHouseDBTimezones', + 'DeleteWhitelistTemplate', + 'CreateWhitelistTemplate', + 'DetachWhitelistTemplateToInstance', + 'UpdateWhitelistTemplate', + 'GetWhitelistTemplate', + 'AttachWhitelistTemplateToInstance', + 'ListWhitelistTemplates', + 'ListInstanceLinkedWhitelistTemplates', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'CreateDBInstance' => [ + 'summary' => 'Creates an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '182031', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN0HBPQ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => 'The client token that is used to ensure the idempotence of the request. You can use the client to generate the token. Make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AB', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + 'title' => '地域id', + ], + ], + [ + 'name' => 'ZoneId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '可用区', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-uf6xmupdn7v6ui9f****', + 'title' => 'VPC ID。', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-uf632qye9oqt4x4sr****', + 'title' => '交换机ID。', + ], + ], + [ + 'name' => 'DBInstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Used for test', + 'title' => '集群说明。', + ], + ], + [ + 'name' => 'EngineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23.8', + 'title' => '引擎版本。', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum capacity for auto scaling.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8', + 'title' => 'serverless弹性伸缩最小值。', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum capacity for auto scaling.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '32', + 'title' => 'serverless弹性伸缩最大值。', + ], + ], + [ + 'name' => 'Engine', + 'in' => 'query', + 'schema' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'enum' => [ + 'clickhouse', + ], + 'title' => '引擎类型。', + ], + ], + [ + 'name' => 'MultiZone', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configurations of multi-zone deployment.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + 'VSwitchIds' => [ + 'description' => 'The vSwitch IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-8vb05l07h3sdayqhe****', + 'title' => '交换机ID。', + ], + 'required' => false, + 'title' => '交换机ID。', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '多可用区配置。', + ], + 'required' => false, + 'title' => '多可用区配置。', + ], + ], + [ + 'name' => 'DeploySchema', + 'in' => 'query', + 'schema' => [ + 'description' => 'The deployment status of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'multi_az', + 'title' => '集群可用区部署状态。', + ], + ], + [ + 'name' => 'SourceDBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-2ze1*********', + 'title' => '集群例ID。', + ], + ], + [ + 'name' => 'BackupSetId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup set ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + 'title' => '备份集ID。', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-*****', + 'title' => '集群所属的资源组ID。', + ], + ], + [ + 'name' => 'NodeScaleMax', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '4', + ], + ], + [ + 'name' => 'NodeScaleMin', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '32', + ], + ], + [ + 'name' => 'NodeCount', + 'in' => 'query', + 'schema' => [ + 'title' => '节点个数，取值范围2-16', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '64', + 'minimum' => '2', + 'example' => '2', + ], + ], + [ + 'name' => 'StorageQuota', + 'in' => 'query', + 'schema' => [ + 'title' => '存储预购量（GB）', + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + 'example' => '100', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'title' => '存储类型。', + 'type' => 'string', + 'example' => 'OSS', + 'enum' => [ + 'oss', + 'ESSD_L1', + 'ESSD_L2', + 'ESSD_L3', + 'SSD', + 'ESSD_L0', + ], + ], + ], + [ + 'name' => 'DBTimeZone', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库内核时区设置，应为IANA时区标识符。', + 'type' => 'string', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'default' => 'enterprise', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签列表', + 'type' => 'array', + 'items' => [ + 'title' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '实例标签键。', + 'type' => 'string', + 'example' => 'user_123', + ], + 'Value' => [ + 'title' => '实例标签值。', + 'type' => 'string', + 'example' => '示例字符串', + ], + ], + ], + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + 'title' => '集群ID。', + ], + 'OrderId' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '21154955706****', + 'title' => '订单ID。', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', + 'title' => '连接地址。', + ], + ], + 'title' => '返回结果。', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"OrderId\\": 0,\\n \\"ConnectionString\\": \\"cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateDBInstance', + ], + 'DeleteDBInstance' => [ + 'summary' => 'Releases an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185379', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the destination cluster.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteDBInstance', + ], + 'StartDBInstance' => [ + 'summary' => 'Starts an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '189351', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F76', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000837', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F76\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000837,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', + 'title' => 'StartDBInstance', + ], + 'RestartDBInstance' => [ + 'summary' => 'Restarts an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '192305', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100001080', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100001080,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', + 'title' => 'RestartDBInstance', + ], + 'StopDBInstance' => [ + 'summary' => 'Stops an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '189348', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100000785', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"TaskId\\": 100000785,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"企业版集群测试\\"\\n }\\n}","type":"json"}]', + 'title' => 'StopDBInstance', + ], + 'ModifyDBInstanceClass' => [ + 'summary' => 'Modifies the elastic scaling settings of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '188578', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + 'title' => '地域ID。', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxxxx', + 'title' => '集群ID。', + ], + ], + [ + 'name' => 'ScaleMin', + 'in' => 'query', + 'schema' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + 'title' => '（参数废弃）serverless弹性伸缩最小值。', + ], + ], + [ + 'name' => 'ScaleMax', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '32', + 'title' => '（参数废弃）serverless弹性伸缩最大值。', + ], + ], + [ + 'name' => 'NodeScaleMax', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最大值。取值范围4-32，且必须大于最小值', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '4', + ], + ], + [ + 'name' => 'NodeScaleMin', + 'in' => 'query', + 'schema' => [ + 'title' => 'serverless节点弹性伸缩最小值。取值范围4-32', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '128', + 'minimum' => '4', + 'example' => '32', + ], + ], + [ + 'name' => 'NodeCount', + 'in' => 'query', + 'schema' => [ + 'title' => '节点个数，取值范围2-16', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '64', + 'minimum' => '1', + 'example' => '2', + ], + ], + [ + 'name' => 'StorageQuota', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'minimum' => '0', + 'example' => '100', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'query', + 'schema' => [ + 'title' => '存储类型。', + 'type' => 'string', + 'example' => 'OSS', + 'enum' => [ + 'oss', + 'ESSD_L1', + 'ESSD_L2', + 'ESSD_L3', + 'SSD', + 'ESSD_L0', + ], + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '计算组id', + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000****', + 'title' => '任务ID。', + ], + 'ScaleMin' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'title' => 'serverless弹性伸缩最小值。', + ], + 'ScaleMax' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + 'title' => 'serverless弹性伸缩最大值。', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'cc-xxxxxxx'."\n", + 'title' => '集群ID。', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxxxx'."\n", + 'title' => '集群名称。', + ], + 'ComputingGroupId' => [ + 'type' => 'string', + ], + ], + 'title' => '返回数据。', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSpecification', + 'errorMessage' => 'Specification parameter is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"ScaleMin\\": 2,\\n \\"ScaleMax\\": 32,\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"ComputingGroupId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceClass', + ], + 'ModifyDBInstanceAttribute' => [ + 'summary' => 'Modifies the configurations of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'AttributeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The configuration that you want to modify.'."\n" + ."\n" + .'* MaintainTime: the O\\&M time'."\n" + .'* DBInstanceDescription: the cluster name'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'DBInstanceDescription', + 'enum' => [ + 'MaintainTime', + 'DBInstanceDescription', + ], + ], + ], + [ + 'name' => 'AttributeValue', + 'in' => 'query', + 'schema' => [ + 'description' => 'The new value of the configuration.', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceAttribute', + ], + 'DescribeDBInstances' => [ + 'summary' => 'Queries a list of ApsaraDB for ClickHouse clusters.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183135', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceIds', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster IDs. Separate multiple cluster IDs with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-xxxxx,cx-xxxx', + ], + ], + [ + 'name' => 'DBInstanceStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster status.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'active', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-4690g37929****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '标签信息。', + 'type' => 'array', + 'items' => [ + 'title' => '标签信息。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签键。', + 'type' => 'string', + 'example' => 'user_123', + ], + 'Value' => [ + 'title' => '标签值。', + 'type' => 'string', + 'example' => '示例值', + ], + ], + ], + 'maxItems' => 20, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DBInstances' => [ + 'description' => 'The clusters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cluster.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxxxx', + ], + 'Description' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'example' => 'test_desc', + ], + 'Engine' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'example' => 'clickhouse', + ], + 'EngineVersion' => [ + 'description' => 'The engine version.'."\n", + 'type' => 'string', + 'example' => '22.8', + ], + 'AliUid' => [ + 'description' => 'The user ID.'."\n", + 'type' => 'string', + 'example' => '1294****', + ], + 'Bid' => [ + 'description' => 'The channel ID.'."\n", + 'type' => 'string', + 'example' => '186681****', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-i', + ], + 'ChargeType' => [ + 'description' => 'The billing method. Valid values:'."\n" + ."\n" + .'* PrePaid: subscription'."\n" + .'* PostPaid: pay-as-you-go'."\n", + 'type' => 'string', + 'example' => 'PostPaid', + ], + 'Status' => [ + 'description' => 'The cluster status.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf6kg****', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-8vb5mw****', + ], + 'ScaleMin' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ScaleMax' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '13', + ], + 'ExpireTime' => [ + 'description' => 'The time when the cluster expires.'."\n", + 'type' => 'string', + 'example' => '2024-02-16 11:51:06', + ], + 'LockMode' => [ + 'description' => 'The lock mode.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'LockReason' => [ + 'description' => 'The reason why the cluster was locked.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'MaintainStartTime' => [ + 'description' => 'The start time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '00:00Z', + ], + 'MaintainEndTime' => [ + 'description' => 'The end time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '04:00:00Z', + ], + 'DeletionProtection' => [ + 'description' => 'Indicates whether the release protection feature is enabled for the cluster.'."\n", + 'type' => 'string', + 'example' => 'False', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmzy****', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created.'."\n", + 'type' => 'string', + 'example' => '2022-12-04 21:16:15', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'tag', + ], + 'Value' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + 'StorageType' => [ + 'title' => '实例存储类型', + 'type' => 'string', + 'example' => 'oss', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": 30,\\n \\"PageNumber\\": 1,\\n \\"DBInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-xxxxxxx\\",\\n \\"Description\\": \\"test_desc\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"22.8\\",\\n \\"AliUid\\": \\"1294****\\",\\n \\"Bid\\": \\"186681****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ZoneId\\": \\"cn-hangzhou-i\\",\\n \\"ChargeType\\": \\"PostPaid\\",\\n \\"Status\\": \\"active\\",\\n \\"VpcId\\": \\"vpc-uf6kg****\\",\\n \\"VSwitchId\\": \\"vsw-8vb5mw****\\",\\n \\"ScaleMin\\": 1,\\n \\"ScaleMax\\": 13,\\n \\"ExpireTime\\": \\"2024-02-16 11:51:06\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"null\\",\\n \\"MaintainStartTime\\": \\"00:00Z\\",\\n \\"MaintainEndTime\\": \\"04:00:00Z\\",\\n \\"DeletionProtection\\": \\"False\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzy****\\",\\n \\"CreateTime\\": \\"2022-12-04 21:16:15\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag\\",\\n \\"Value\\": \\"test\\"\\n }\\n ],\\n \\"StorageType\\": \\"oss\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"xxx-xxx-xxx\\"\\n}","type":"json"}]', + 'title' => 'DescribeDBInstances', + ], + 'DescribeDBInstanceAttribute' => [ + 'summary' => 'Queries the details of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '183134', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + 'title' => '集群ID。', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* cn-beijing'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'cn-beijing' => 'cn-beijing', + ], + 'example' => 'cn-hangzhou', + 'title' => '地域ID。', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + 'title' => '集群ID。', + ], + 'Description' => [ + 'description' => 'The cluster description.'."\n", + 'type' => 'string', + 'example' => 'Used for test', + 'title' => '集群描述。', + ], + 'Engine' => [ + 'description' => 'The engine type.'."\n", + 'type' => 'string', + 'example' => 'clickhouse', + 'title' => '引擎类型。', + ], + 'EngineVersion' => [ + 'description' => 'The engine version.'."\n", + 'type' => 'string', + 'example' => '23.8', + 'title' => '引擎版本。', + ], + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '140692647406****', + 'title' => '阿里云账号ID。', + ], + 'Bid' => [ + 'description' => 'The channel ID.'."\n", + 'type' => 'string', + 'example' => 'PD39050615820269****', + 'title' => '渠道ID。', + ], + 'RegionId' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou', + 'title' => '地域ID。', + ], + 'DeploySchema' => [ + 'description' => 'The deployment mode of the cluster. Valid values: single_az and multi_az.'."\n" + ."\n" + .'* single_az: indicates that the server nodes are deployed in the primary zone. The ID of the primary zone is specified by the ZoneID parameter.'."\n" + .'* multi_az: indicates that the server nodes are deployed in multiple zones. The information about the zones is specified by the MultiZones parameter.'."\n" + ."\n" + .'The keeper nodes are deployed in multiple zones.'."\n", + 'type' => 'string', + 'example' => 'single_az', + 'title' => '集群可用区部署状态，支持single_az和multi_az两种类型。'."\n" + ."\n" + .'- single_az：server部署到主可用区ZoneId。'."\n" + .'- multi_az：server部署到多可用区MultiZones。'."\n" + ."\n" + .'keeper始终部署到多可用区MultiZones。', + ], + 'MultiZones' => [ + 'description' => 'The information about the zones.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VSwitchIds' => [ + 'description' => 'The vSwitch IDs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-bj9kpwhcb9iekphje1ljz', + 'title' => '交换机ID。', + ], + 'title' => '交换机ID。', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + ], + 'description' => '', + 'title' => '多可用信息。', + ], + 'title' => '多可用信息。', + ], + 'ChargeType' => [ + 'description' => 'The billing method. Enterprise Edition clusters use the pay-as-you-go billing method.'."\n", + 'type' => 'string', + 'example' => 'PrePaid', + 'title' => '付费方式。 '."\n" + .'企业版集群的付费方式都是按量付费方式。', + ], + 'Status' => [ + 'description' => 'The cluster status.'."\n", + 'type' => 'string', + 'example' => 'active', + 'title' => '实例状态。', + ], + 'VpcId' => [ + 'description' => 'The virtual private cloud (VPC) ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-wz9duj8xd6r1gzhsg*****', + 'title' => 'VPC ID。', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-uf67ij56zm9x4uc6hmilg', + 'title' => '交换机ID。', + ], + 'ScaleMin' => [ + 'description' => 'The minimum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + 'title' => 'serverless弹性伸缩最小值。', + ], + 'ScaleMax' => [ + 'description' => 'The maximum capacity for elastic scaling.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '32', + 'title' => 'serverless弹性伸缩最大值。', + ], + 'StorageSize' => [ + 'description' => 'The size of the storage space. Unit: GB.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + 'title' => '存储空间大小。单位：GB', + ], + 'StorageType' => [ + 'description' => 'The storage type.'."\n", + 'type' => 'string', + 'example' => '100', + 'title' => '存储类型。', + ], + 'ObjectStoreSize' => [ + 'description' => 'The size of the object storage space.'."\n", + 'type' => 'string', + 'example' => '13', + 'title' => '对象存储大小。', + ], + 'ExpireTime' => [ + 'description' => 'The time when the cluster expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n" + ."\n" + .'> Pay-as-you-go clusters never expire. If the cluster is a pay-as-you-go cluster, an empty string is returned for this parameter.'."\n", + 'type' => 'string', + 'example' => '2024-04-17T08:14:48Z', + 'title' => '集群的到期时间，格式：yyyy-MM-ddTHH:mm:ssZ。'."\n" + .'>按量付费集群无到期时间，返回值为空。', + ], + 'LockMode' => [ + 'description' => 'The lock mode of the cluster.'."\n", + 'type' => 'string', + 'example' => '0', + 'title' => '集群的锁定模式。', + ], + 'LockReason' => [ + 'description' => 'The reason why the cluster was locked.'."\n", + 'type' => 'string', + 'example' => 'nolock', + 'title' => '锁定原因。', + ], + 'MaintainStartTime' => [ + 'description' => 'The start time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '12:00', + 'title' => '可维护时间开始时间。', + ], + 'MaintainEndTime' => [ + 'description' => 'The end time of the maintenance window.'."\n", + 'type' => 'string', + 'example' => '21:00', + 'title' => '可维护时间结束时间。', + ], + 'DeletionProtection' => [ + 'description' => 'Indicates whether the release protection feature is enabled for the cluster.'."\n", + 'type' => 'boolean', + 'example' => '0/1', + 'title' => '是否已开启释放保护功能。', + ], + 'ResourceGroupId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'string', + 'example' => 'rg-acfmzygvt54****', + 'title' => '资源ID。', + ], + 'Tags' => [ + 'description' => 'The details of the tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'example' => 'id', + 'title' => '标签的名称。', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'example' => 'ck', + 'title' => '标签的值。', + ], + ], + 'title' => '标签信息。', + ], + 'title' => '标签信息。', + ], + 'Nodes' => [ + 'description' => 'The nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The node.'."\n", + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + 'NodeStatus' => [ + 'description' => 'The node status.'."\n", + 'type' => 'string', + 'example' => 'active', + 'title' => '节点运行状态。', + ], + ], + 'title' => '节点信息。', + ], + 'title' => '节点信息。', + ], + 'CreateTime' => [ + 'description' => 'The time when the cluster was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.'."\n", + 'type' => 'string', + 'example' => '2023-09-14T08:14:48Z', + 'title' => '集群的创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。', + ], + 'EngineMinorVersion' => [ + 'description' => 'The minor engine version of the cluster.'."\n", + 'type' => 'string', + 'example' => '23.8.1.41495_6', + 'title' => '集群引擎的小版本号。', + ], + 'LatestEngineMinorVersion' => [ + 'description' => 'The latest minor engine version.'."\n", + 'type' => 'string', + 'example' => '23.8.1.41495_6', + 'title' => '最新内核小版本号。', + ], + 'DisabledPorts' => [ + 'description' => 'The disabled database ports. Multiple database ports are separated by commas (,).'."\n", + 'type' => 'string', + 'example' => '9001,8123', + 'title' => '禁用指定数据库端口，支持传入英文逗号（,）隔开的多个端口。', + ], + 'ZoneId' => [ + 'description' => 'The zone ID.'."\n", + 'type' => 'string', + 'example' => 'cn-hangzhou-h', + 'title' => '可用区ID。', + ], + 'StorageQuota' => [ + 'title' => '存储预购量（GB）。', + 'type' => 'string', + 'example' => '100', + ], + 'NodeScaleMax' => [ + 'title' => 'Serverless节点弹性最大值。', + 'type' => 'string', + 'example' => '32', + ], + 'NodeScaleMin' => [ + 'title' => 'Serverless节点弹性最小值。', + 'type' => 'string', + 'example' => '4', + ], + 'NodeCount' => [ + 'title' => '节点数量。', + 'type' => 'string', + 'example' => '2', + ], + 'Category' => [ + 'title' => '类型，取值说明：'."\n" + ."\n" + .'- enterprise 企业版', + 'type' => 'string', + 'example' => 'enterprise', + ], + 'ClickObserveServiceStatus' => [ + 'title' => 'ClickObserve服务状态', + 'type' => 'string', + 'example' => 'activation', + ], + ], + 'title' => '返回结果。', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Description\\": \\"集群测试\\",\\n \\"Engine\\": \\"clickhouse\\",\\n \\"EngineVersion\\": \\"23.8\\",\\n \\"AliUid\\": 0,\\n \\"Bid\\": \\"PD39050615820269****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"DeploySchema\\": \\"single_az\\",\\n \\"MultiZones\\": [\\n {\\n \\"VSwitchIds\\": [\\n \\"vsw-bj9kpwhcb9iekphje1ljz\\"\\n ],\\n \\"ZoneId\\": \\"cn-hangzhou-h\\"\\n }\\n ],\\n \\"ChargeType\\": \\"POSTPAY\\",\\n \\"Status\\": \\"ACTIVATION\\",\\n \\"VpcId\\": \\"vpc-wz9duj8xd6r1gzhsg*****\\",\\n \\"VSwitchId\\": \\"vsw-uf67ij56zm9x4uc6hmilg\\",\\n \\"ScaleMin\\": 8,\\n \\"ScaleMax\\": 32,\\n \\"StorageSize\\": 12,\\n \\"StorageType\\": \\"100\\",\\n \\"ObjectStoreSize\\": \\"13\\",\\n \\"ExpireTime\\": \\"2024-04-17T08:14:48Z\\",\\n \\"LockMode\\": \\"0\\",\\n \\"LockReason\\": \\"nolock\\",\\n \\"MaintainStartTime\\": \\"11:00Z\\",\\n \\"MaintainEndTime\\": \\"12:00Z\\",\\n \\"DeletionProtection\\": true,\\n \\"ResourceGroupId\\": \\"rg-acfmzygvt54****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"id\\",\\n \\"Value\\": \\"ck\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"NodeStatus\\": \\"active\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-14T08:14:48Z\\",\\n \\"EngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"LatestEngineMinorVersion\\": \\"23.8.1.41495_6\\",\\n \\"DisabledPorts\\": \\"9001,8123\\",\\n \\"ZoneId\\": \\"cn-hangzhou-h\\",\\n \\"StorageQuota\\": \\"100\\",\\n \\"NodeScaleMax\\": \\"32\\",\\n \\"NodeScaleMin\\": \\"4\\",\\n \\"NodeCount\\": \\"2\\",\\n \\"Category\\": \\"enterprise\\",\\n \\"ClickObserveServiceStatus\\": \\"activation\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBInstanceAttribute', + ], + 'UpgradeMinorVersion' => [ + 'summary' => 'Updates the minor engine version of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '196979', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN0HBPQ', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1jyis8p15we****', + ], + ], + [ + 'name' => 'SwitchTimeMode', + 'in' => 'query', + 'schema' => [ + 'title' => '切换模式', + 'description' => 'Specifies whether to update the minor engine version of the cluster immediately. Valid values:'."\n" + ."\n" + .'* **Immediate**: The system immediately performs the update.'."\n" + .'* **MaintainTime**: The system performs the update during the specified maintenance window.'."\n" + .'* **SpecifyTime**: The system performs the update at a specified time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Immediate', + 'default' => 'Immediate', + 'enum' => [ + 'Immediate', + 'MaintainTime', + 'SpecifyTime', + ], + ], + ], + [ + 'name' => 'SwitchTime', + 'in' => 'query', + 'schema' => [ + 'title' => '指定时间点切换时，指定切换时间点。', + 'description' => 'The update time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.'."\n" + ."\n" + .'> If you set SwitchTimeMode to SpecifyTime, you must configure this parameter to specify the update time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-09T05:00:00Z', + ], + ], + [ + 'name' => 'TargetMinorVersion', + 'in' => 'query', + 'schema' => [ + 'title' => '目标内核小版本，默认升级到最新。', + 'description' => 'The minor engine version to which you want to update.'."\n" + ."\n" + .'> By default, TargetMinorVersion is not set and the minor engine version of the cluster is updated to the latest version.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23.8.1.41495_6', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'FE242962-6DA3-5FC8-9691-37B62A3210F7', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceName' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'string', + 'example' => 'cc-uf6x229yeq166****', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FE242962-6DA3-5FC8-9691-37B62A3210F7\\",\\n \\"Data\\": {\\n \\"DBInstanceName\\": \\"cc-uf6x229yeq166****\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpgradeMinorVersion', + ], + 'CreateAccount' => [ + 'summary' => 'Creates a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185272', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseL1079N', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'AccountType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **NormalAccount**: standard account'."\n" + .'* **SuperAccount**: privileged account'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'NormalAccount', + 'enum' => [ + 'SuperAccount', + 'NormalAccount', + ], + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database account. The password must meet the following requirements:'."\n" + ."\n" + .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'- The following special characters are supported: ! @ # $ % ^ & * ( ) _ + - ='."\n" + .'- The password must be 8 to 32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => 'a1b2c3d4@', + ], + ], + [ + 'name' => 'DmlAuthSetting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'DmlAuthority' => [ + 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n" + ."\n" + .'* **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n" + .'* **1**: The account only has the permissions to read data from the database.'."\n" + .'* **2**: The account only has the permissions to read data from the database and modify the settings of the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'DdlAuthority' => [ + 'description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n" + ."\n" + .'* **true**: The account has the permissions to execute DDL statements.'."\n" + .'* **false**: The account does not have the permissions to execute DDL statements.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AllowDictionaries' => [ + 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dc1,dc2', + ], + 'required' => false, + ], + 'AllowDatabases' => [ + 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db1,db2', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Used for account', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidAccountType.Malformed', + 'errorMessage' => 'The specified parameter "AccountType" is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountName.Malformed', + 'errorMessage' => 'The specified parameter "Account" is not valid.', + ], + [ + 'errorCode' => 'InvalidAccountPassword.Malformed', + 'errorMessage' => 'The specified parameter "Password" is not valid.', + ], + ], + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateAccount', + ], + 'DeleteAccount' => [ + 'summary' => 'Deletes a database account from an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '185273', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '21D06907-CEA5-561D-B6B1-198BCCE99ED1', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21D06907-CEA5-561D-B6B1-198BCCE99ED1\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteAccount', + ], + 'ResetAccountPassword' => [ + 'summary' => 'Resets the password of a database account for an ApsaraDB for ClickHouse Enterprise Edition cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185276', + 'abilityTreeNodes' => [ + 'FEATUREclickhouse2H8YOY', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => 'The password of the database account. The password must meet the following requirements:'."\n" + ."\n" + .'- The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.'."\n" + .'- The following special characters are supported: ! @ # $ % ^ & * ( ) _ + - ='."\n" + .'- The password must be 8 to 32 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => '123456Aa', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The service name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '5A6A077A-577C-536E-AC13-8E715D7A34C8', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A6A077A-577C-536E-AC13-8E715D7A34C8\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'ResetAccountPassword', + ], + 'ModifyAccountDescription' => [ + 'summary' => 'Modifies the description of a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185303', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxxxx', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxx', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'testuser', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7FFC9EBE-5023-5D5D-A5F0-1607E0F2****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp1anv7jo84t****\\",\\n \\"Account\\": \\"testuser\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyAccountDescription', + ], + 'ModifyAccountAuthority' => [ + 'summary' => 'Modifies the permissions of a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185304', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + [ + 'name' => 'DmlAuthSetting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The information about permissions.'."\n", + 'type' => 'object', + 'properties' => [ + 'DmlAuthority' => [ + 'description' => 'Specifies whether to grant the DML permissions to the database account. Valid values:'."\n" + ."\n" + .'* **0**: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n" + .'* **1**: The account only has the permissions to read data from the database.'."\n" + .'* **2**: The account only has the permissions to read data from the database and modify the settings of the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + ], + ], + 'DdlAuthority' => [ + 'description' => 'Specifies whether to grant the DDL permissions to the database account. Valid values:'."\n" + ."\n" + .'* **true**: The account has the permissions to execute DDL statements.'."\n" + .'* **false**: The account does not have the permissions to execute DDL statements.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + 'AllowDictionaries' => [ + 'description' => 'The dictionaries on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary on which you want to grant permissions. Separate multiple dictionaries with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db1,db2', + ], + 'required' => false, + ], + 'AllowDatabases' => [ + 'description' => 'The databases on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database on which you want to grant permissions. Separate multiple databases with commas (,).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db1,db2', + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '05321590-BB65-4720-8CB6-8218E041CDD0', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8CB6-8218E041CDD0\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyAccountAuthority', + ], + 'DescribeAccounts' => [ + 'summary' => 'Queries database accounts for an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185288', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Data' => [ + 'description' => 'The result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* **30** (default)'."\n" + .'* **50**'."\n" + .'* **100**'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'Accounts' => [ + 'description' => 'The database accounts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Account' => [ + 'description' => 'The username of the database account.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Used for test', + ], + 'AccountType' => [ + 'description' => 'The type of the database account. Valid values:'."\n" + ."\n" + .'* **1**: standard account'."\n" + .'* **6**: privileged account'."\n", + 'type' => 'string', + 'example' => 'NormalAccount', + ], + 'Status' => [ + 'description' => 'The state of the database account. Valid values:'."\n" + ."\n" + .'* **0**: The database account is being created.'."\n" + .'* **1**: The database account is in use.'."\n" + .'* **3**: The database account is being deleted.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 30,\\n \\"Accounts\\": [\\n {\\n \\"Account\\": \\"test\\",\\n \\"Description\\": \\"测试使用\\",\\n \\"AccountType\\": \\"1\\",\\n \\"Status\\": \\"1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAccounts', + ], + 'DescribeAccountAuthority' => [ + 'summary' => 'Queries the permissions of a database account.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185309', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'Account', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Account' => [ + 'description' => 'The name of the database account.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + 'DmlAuthority' => [ + 'description' => 'Indicates whether the DML permissions are granted to the database account. Valid values:'."\n" + ."\n" + .'* 0: The account has the permissions to read data from the database, write data to the database, and modify the settings of the database.'."\n" + .'* 1: The account only has the permissions to read data from the database.'."\n" + .'* 2: The account only has the permissions to read data from the database and modify the settings of the database.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DdlAuthority' => [ + 'description' => 'Indicates whether the DDL permissions are granted to the database account. Valid values:'."\n" + ."\n" + .'* **true**: The account has the permissions to execute DDL statements.'."\n" + .'* **false**: The account does not have the permissions to execute DDL statements.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'AllowDatabases' => [ + 'description' => 'The databases on which permissions are granted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The database on which permissions are granted.'."\n", + 'type' => 'string', + 'example' => 'db1', + ], + ], + 'AllowDictionaries' => [ + 'description' => 'The dictionaries on which permissions are granted.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary on which permissions are granted.'."\n", + 'type' => 'string', + 'example' => 'dt1', + ], + ], + 'TotalDatabases' => [ + 'description' => 'All databases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The databases.'."\n", + 'type' => 'string', + 'example' => 'db1,db2', + ], + ], + 'TotalDictionaries' => [ + 'description' => 'The database.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The dictionary of a database. The value is in the db.dict format.'."\n", + 'type' => 'string', + 'example' => 'test1.range_key_dict', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + [ + 'errorCode' => 'InvalidAccountName.NotFound', + 'errorMessage' => 'Specified account name does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC911****\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Account\\": \\"test1\\",\\n \\"DmlAuthority\\": 0,\\n \\"DdlAuthority\\": true,\\n \\"AllowDatabases\\": [\\n \\"db1\\"\\n ],\\n \\"AllowDictionaries\\": [\\n \\"dt1\\"\\n ],\\n \\"TotalDatabases\\": [\\n \\"db1,db2\\"\\n ],\\n \\"TotalDictionaries\\": [\\n \\"test1.range_key_dict\\"\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAccountAuthority', + ], + 'CreateDB' => [ + 'summary' => 'Creates an ApsaraDB for ClickHouse database.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185311', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name. The name must meet the following requirements:'."\n" + ."\n" + .'* The name can contain lowercase letters, digits, underscores (\\_), and hyphens (-).'."\n" + .'* The name must start with a lowercase letter and end with a lowercase letter or digit.'."\n" + .'* The name can be up to 64 characters in length.'."\n" + ."\n" + .'> An underscore (\\_) is counted as two characters.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdb001', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'description' => 'Database remark information.', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '94F92113-FF63-5E57-8401-6FE123AD11DD', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'testdb001', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94F92113-FF63-5E57-8401-6FE123AD11DD\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateDB', + ], + 'DeleteDB' => [ + 'summary' => 'Deletes an ApsaraDB for ClickHouse database.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185312', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the destination database.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'testdb001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '06798FEE-BEF2-5FAF-A30D-728973BBE97C', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBName' => [ + 'description' => 'The name of the database.'."\n", + 'type' => 'string', + 'example' => 'testdb001', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'InvalidDBInstanceState.NotSupport', + 'errorMessage' => 'The specified instance state does\'t support this operation.', + ], + ], + [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"06798FEE-BEF2-5FAF-A30D-728973BBE97C\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"DBName\\": \\"testdb001\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteDB', + ], + 'DescribeDBInstanceDataSources' => [ + 'summary' => 'Queries the schema of a database or a table.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185313', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dbtest', + ], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tableTest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F543E6CC-6868-523D-8D28-0E92CF977ED2', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Schemas' => [ + 'description' => 'The account.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'Tables' => [ + 'description' => 'The tables.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The table.'."\n", + 'type' => 'string', + 'example' => 'table_test', + ], + ], + 'Columns' => [ + 'description' => 'The columns.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The column.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBName' => [ + 'description' => 'The database name.'."\n", + 'type' => 'string', + 'example' => 'dbtest', + ], + 'Type' => [ + 'description' => 'The type of the stored data.'."\n", + 'type' => 'string', + 'example' => 'UInt64', + ], + 'TableName' => [ + 'description' => 'The table name.'."\n", + 'type' => 'string', + 'example' => 'tableTest', + ], + 'ColumnName' => [ + 'description' => 'The column name.'."\n", + 'type' => 'string', + 'example' => 'c31', + ], + 'PrimaryKey' => [ + 'description' => 'Indicates whether the column is the primary key of the table. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'false', + ], + 'Comment' => [ + 'description' => 'The description of the database account.'."\n", + 'type' => 'string', + 'example' => 'Used for test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound ', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F543E6CC-6868-523D-8D28-0E92CF977ED2\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Schemas\\": \\"default\\",\\n \\"Tables\\": [\\n \\"table_test\\"\\n ],\\n \\"Columns\\": [\\n {\\n \\"DBName\\": \\"dbtest\\",\\n \\"Type\\": \\"UInt64\\",\\n \\"TableName\\": \\"tableTest\\",\\n \\"ColumnName\\": \\"c31\\",\\n \\"PrimaryKey\\": \\"false\\",\\n \\"Comment\\": \\"测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeDBInstanceDataSources', + ], + 'CreateEndpoint' => [ + 'summary' => 'Applies for a public endpoint.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185384', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseZHDS8I', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'DBInstanceNetType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The network type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Public'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Public', + 'enum' => [ + 'Public', + ], + ], + ], + [ + 'name' => 'ConnectionPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the new endpoint. The prefix of the ConnectionString parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2FED790E-FB61-4721-8C1C-07C627FA5A19', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FED790E-FB61-4721-8C1C-07C627FA5A19\\"\\n}","type":"json"}]', + 'title' => 'CreateEndpoint', + ], + 'DeleteEndpoint' => [ + 'summary' => 'Releases a public endpoint.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185385', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the endpoint, which indicates the prefix of the value of the ConnectionString parameter.', + 'type' => 'string', + 'required' => false, + 'example' => 'cc-bp100p4q1g9z3****-clickhouse.clickhouseserver.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'DBInstanceNetType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + 'title' => 'DeleteEndpoint', + ], + 'ModifyDBInstanceConnectionString' => [ + 'summary' => 'Modifies the endpoint of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '186649', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'ConnectionString', + 'in' => 'query', + 'schema' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', + ], + ], + [ + 'name' => 'ConnectionStringPrefix', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the endpoint that is used to connect to the database.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cc-****-clickhouse', + ], + ], + [ + 'name' => 'DisablePorts', + 'in' => 'query', + 'schema' => [ + 'description' => '* The database ports that you want to disable. Separate multiple ports with commas (,).'."\n" + ."\n" + .'* This parameter is supported only for clusters whose minor engine version is 24.10.1.11098\\_1 or later.'."\n" + ."\n" + .' **'."\n" + ."\n" + .' **Note** If you create a cluster whose minor engine version is earlier than 24.10.1.11098\\_1 and you update the minor engine version to 24.10.1.11098\\_1 or later, the cluster still does not support this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9001,8123', + ], + ], + [ + 'name' => 'DBInstanceNetType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'Public', + ], + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxxx', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxx', + ], + 'DisabledPorts' => [ + 'description' => 'The disabled database ports.'."\n", + 'type' => 'string', + 'example' => '9001,8123', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"ConnectionString\\": \\"cc-2ze34****-clickhouse..clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"DBInstanceName\\": \\"cc-xxxxx\\",\\n \\"DisabledPorts\\": \\"9001,8123\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifyDBInstanceConnectionString', + ], + 'ModifySecurityIPList' => [ + 'summary' => 'Modifies the whitelist settings of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the whitelist whose settings you want to modify.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '192.168.0.0/24,172.16.0.0/24', + ], + ], + [ + 'name' => 'ModifyMode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The modification mode.'."\n" + ."\n" + .'* 0: overwrites the original IP addresses and CIDR blocks in the whitelist.'."\n" + .'* 1: adds the IP addresses and CIDR blocks to the whitelist.'."\n" + .'* 2: removes the IP addresses and CIDR blocks from the whitelist.'."\n" + ."\n" + .'> We recommend that you set the value to 0.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => 'The name of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SecurityIPType' => [ + 'description' => 'The IP address type.'."\n", + 'type' => 'string', + 'example' => 'ipv4', + ], + 'GroupTag' => [ + 'description' => 'The tag of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'TaskId' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SecurityIPList' => [ + 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", + 'type' => 'string', + 'example' => '192.168.0.0/24,172.16.0.0/24', + ], + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxx', + ], + 'WhitelistNetType' => [ + 'description' => 'The network type of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'mix', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxx', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records. ', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"GroupName\\": \\"test\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"TaskId\\": 1,\\n \\"SecurityIPList\\": \\"192.168.0.0/24,172.16.0.0/24\\",\\n \\"DBInstanceID\\": 0,\\n \\"WhitelistNetType\\": \\"mix\\",\\n \\"DBInstanceName\\": \\"cc-xxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'ModifySecurityIPList', + ], + 'DescribeSecurityIPList' => [ + 'summary' => 'Queries the whitelist of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '185650', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'TestCluster', + ], + 'GroupItems' => [ + 'description' => 'The details about the whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details about the whitelist.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => 'The name of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'default', + ], + 'SecurityIPType' => [ + 'description' => 'The IP address type.'."\n", + 'type' => 'string', + 'example' => 'ipv4', + ], + 'GroupTag' => [ + 'description' => 'The tag of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'SecurityIPList' => [ + 'description' => 'The IP addresses and CIDR blocks in the whitelist.'."\n", + 'type' => 'string', + 'example' => '127.0.XX.XX', + ], + 'WhitelistNetType' => [ + 'description' => 'The network type of the whitelist.'."\n", + 'type' => 'string', + 'example' => 'mix', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"GroupItems\\": [\\n {\\n \\"GroupName\\": \\"default\\",\\n \\"SecurityIPType\\": \\"ipv4\\",\\n \\"GroupTag\\": \\"test\\",\\n \\"SecurityIPList\\": \\"127.0.XX.XX\\",\\n \\"WhitelistNetType\\": \\"mix\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSecurityIPList', + ], + 'DescribeEndpoints' => [ + 'summary' => 'Queries the endpoint of an ApsaraDB for ClickHouse cluster.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185373', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '计算组ID。', + 'type' => 'string', + 'example' => 'cc-*****-clickhouse', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceNetworkType' => [ + 'description' => 'The network type of the cluster. Valid values:'."\n" + ."\n" + .'* **VPC**'."\n" + .'* **PUBLIC**'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Endpoints' => [ + 'description' => 'The details of the endpoints.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the endpoint.'."\n", + 'type' => 'object', + 'properties' => [ + 'NetType' => [ + 'description' => 'The network type of the endpoint. Valid values:'."\n" + ."\n" + .'* VPC'."\n" + .'* PUBLIC'."\n", + 'type' => 'string', + 'example' => 'VPC', + ], + 'Status' => [ + 'description' => 'The state of the cluster.'."\n", + 'type' => 'string', + 'example' => 'active', + ], + 'ConnectionString' => [ + 'description' => 'The endpoint of the cluster.'."\n", + 'type' => 'string', + 'example' => 'cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com', + ], + 'VpcId' => [ + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'example' => 'vpc-uf61z****', + ], + 'VSwitchId' => [ + 'description' => 'The vSwitch ID.'."\n", + 'type' => 'string', + 'example' => 'vsw-0xi8829****', + ], + 'VpcInstanceId' => [ + 'description' => 'The VPC ID.'."\n", + 'type' => 'string', + 'example' => 'vpc-uf61z****', + ], + 'Ports' => [ + 'description' => 'The details of the ports.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the port.'."\n", + 'type' => 'object', + 'properties' => [ + 'Protocol' => [ + 'description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* HttpPort'."\n" + .'* HttpsPort'."\n" + .'* TcpPort'."\n", + 'type' => 'string', + 'example' => 'HttpPort', + ], + 'Port' => [ + 'description' => 'The port used to connect to the cluster. Valid values:'."\n" + ."\n" + .'* 8123: This value is returned when the value of Protocol is HttpPort.'."\n" + .'* 8443: This value is returned when the value of Protocol is HttpsPort.'."\n" + .'* 9000: This value is returned when the value of Protocol is TcpPort.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8123', + ], + ], + ], + ], + 'IPAddress' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'string', + 'example' => '172.30.XX.XX', + ], + 'ComputingGroupId' => [ + 'title' => '计算组id', + 'type' => 'string', + 'example' => 'cc-ad321**-clickhouse', + ], + 'EndpointName' => [ + 'title' => '连接串名称', + 'type' => 'string', + 'example' => 'cc-*****-clickhouse', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidDBInstanceId.NotFound', + 'errorMessage' => 'The DBInstanceId provided does not exist in our records.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"InstanceNetworkType\\": \\"VPC\\",\\n \\"Endpoints\\": [\\n {\\n \\"NetType\\": \\"VPC\\",\\n \\"Status\\": \\"active\\",\\n \\"ConnectionString\\": \\"cc-****-clickhouse.clickhouseserver.pre.rds.aliyuncs.com\\",\\n \\"VpcId\\": \\"vpc-uf61z****\\",\\n \\"VSwitchId\\": \\"vsw-0xi8829****\\",\\n \\"VpcInstanceId\\": \\"vpc-uf61z****\\",\\n \\"Ports\\": [\\n {\\n \\"Protocol\\": \\"HttpPort\\",\\n \\"Port\\": 8123\\n }\\n ],\\n \\"IPAddress\\": \\"172.30.XX.XX\\",\\n \\"ComputingGroupId\\": \\"cc-ad321**-clickhouse\\",\\n \\"EndpointName\\": \\"cc-*****-clickhouse\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeEndpoints', + ], + 'DescribeProcessList' => [ + 'summary' => 'Views running queries.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186631', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: 1000. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'InitialUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The user who executes the query statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'testuser', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'The keyword of the query statement.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SELECT', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'QueryOrder', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the columns by which the query results are sorted in descending order.'."\n" + ."\n" + .'* 0: The query results are sorted by the query_duration_ms column.'."\n" + .'* 1: The query results are sorted by the query_duration_ms and query_start_time columns.'."\n" + .'* 2: The query results are sorted by the query_duration_ms, query_start_time, and user columns.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'id', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxx', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResultSet' => [ + 'description' => 'The result sets.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InitialQueryId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'', + ], + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to query. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-07-23T10:13:23Z', + ], + 'InitialAddress' => [ + 'description' => 'The address to which the query statement is sent.'."\n", + 'type' => 'string', + 'example' => '0:0:0:0:0:ffff:1edd65ea', + ], + 'Query' => [ + 'description' => 'The query statement that is running.'."\n", + 'type' => 'string', + 'example' => 'select * from test', + ], + 'InitialUser' => [ + 'description' => 'The user who executes the query statement.'."\n", + 'type' => 'string', + 'example' => 'bany', + ], + 'QueryDurationMs' => [ + 'description' => 'The minimum query duration. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"测试使用\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"InitialQueryId\\": \\"\'79f7e40b-87e2-4ef4-b6df-21889a3a030e\'\\",\\n \\"QueryStartTime\\": \\"2023-07-23T10:13:23Z\\",\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeProcessList', + ], + 'KillProcess' => [ + 'summary' => 'Terminates an ongoing query.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186648', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxxxx', + ], + ], + [ + 'name' => 'InitialQueryId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'xxx-xxx-xxx', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-xxxxxxx', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'cc-xxxxxxx'."\n", + ], + 'Count' => [ + 'description' => 'The number of queries that are terminated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxx-xxx-xxx\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"cc-xxxxxxx\\\\n\\",\\n \\"Count\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'KillProcess', + ], + 'DescribeSlowLogTrend' => [ + 'summary' => 'Queries the trend of slow query logs.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186604', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-04-13 17:48:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-06-07 10:03:00', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3000', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the cloud service.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + 'default' => 'clickhouse', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF', + ], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'clusterTest', + ], + 'ResultSet' => [ + 'description' => 'The result sets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result set.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to query. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-04-13 17:48:00', + ], + 'MaxQueryDurationMs' => [ + 'description' => 'The maximum execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'Cnt' => [ + 'description' => 'The total number of SQL queries within the specified time range.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MinQueryDurationMs' => [ + 'description' => 'The minimum execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'AvgQueryDurationMs' => [ + 'description' => 'The average execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7D3ECB0E-98CA-5E08-A9CA-F70C5A1E9BDF\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-04-13 17:48:00\\",\\n \\"MaxQueryDurationMs\\": 3000,\\n \\"Cnt\\": 1,\\n \\"MinQueryDurationMs\\": 1000,\\n \\"AvgQueryDurationMs\\": 2000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSlowLogTrend', + ], + 'DescribeSlowLogRecords' => [ + 'summary' => 'Queries the details of slow query logs.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '186629', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-09-11 16:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd hh:mm:ss format. The time must be in UTC.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2023-09-15 16:00:00', + ], + ], + [ + 'name' => 'QueryDurationMs', + 'in' => 'query', + 'schema' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3000', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Valid values:'."\n" + ."\n" + .'* 30 (default)'."\n" + .'* 50'."\n" + .'* 100'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ComputingGroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DF203CC8-5F68-5E3F-8050-3C77DD65731A', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'DBInstanceID' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => 'cc-bp100p4q1g9z32****', + ], + 'DBInstanceName' => [ + 'description' => 'The cluster name.'."\n", + 'type' => 'string', + 'example' => 'TestCluster', + ], + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ResultSet' => [ + 'description' => 'The result sets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The result set.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueryStartTime' => [ + 'description' => 'The beginning of the time range to query. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.'."\n", + 'type' => 'string', + 'example' => '2023-09-11 16:00:00', + ], + 'InitialQueryId' => [ + 'description' => 'The query ID.'."\n", + 'type' => 'string', + 'example' => '\'ae915a3ad30e77e67a7215d05b658cc6\'', + ], + 'ReadRows' => [ + 'description' => 'The number of read rows.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'InitialAddress' => [ + 'description' => 'The address to which the query statement is sent.'."\n", + 'type' => 'string', + 'example' => '0:0:0:0:0:ffff:1edd65ea', + ], + 'Query' => [ + 'description' => 'The query statement that is running.'."\n", + 'type' => 'string', + 'example' => 'select * from test', + ], + 'MemoryUsage' => [ + 'description' => 'The peak memory usage for the query. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4941696', + ], + 'Type' => [ + 'description' => 'The type of the slow query logs.'."\n", + 'type' => 'string', + 'example' => 'ExceptionWhileProcessing', + ], + 'ReadBytes' => [ + 'description' => 'The size of the data that is scanned. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '4507128020832', + ], + 'InitialUser' => [ + 'description' => 'The user who executes the query statement.'."\n", + 'type' => 'string', + 'example' => 'bany', + ], + 'QueryDurationMs' => [ + 'description' => 'The execution duration of slow SQL queries. Minimum value: **1000**. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3000', + ], + 'ResultBytes' => [ + 'description' => 'The size of the result data. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF203CC8-5F68-5E3F-8050-3C77DD65731A\\",\\n \\"Data\\": {\\n \\"DBInstanceID\\": 0,\\n \\"DBInstanceName\\": \\"集群测试\\",\\n \\"TotalCount\\": 1,\\n \\"ResultSet\\": [\\n {\\n \\"QueryStartTime\\": \\"2023-09-11 16:00:00\\",\\n \\"InitialQueryId\\": \\"\'ae915a3ad30e77e67a7215d05b658cc6\'\\",\\n \\"ReadRows\\": 10,\\n \\"InitialAddress\\": \\"0:0:0:0:0:ffff:1edd65ea\\",\\n \\"Query\\": \\"select * from test\\",\\n \\"MemoryUsage\\": 4941696,\\n \\"Type\\": \\"ExceptionWhileProcessing\\",\\n \\"ReadBytes\\": 4507128020832,\\n \\"InitialUser\\": \\"bany\\",\\n \\"QueryDurationMs\\": 3000,\\n \\"ResultBytes\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'DescribeSlowLogRecords', + ], + 'ModifyBackupPolicy' => [ + 'summary' => 'Modifies the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '15:00Z-16:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Monday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + 'title' => 'ModifyBackupPolicy', + ], + 'DescribeBackupPolicy' => [ + 'summary' => 'View the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp100p4q1g9z3****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'PreferredBackupPeriod' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Monday', + ], + 'Switch' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PreferredBackupTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '15:00Z-16:00Z', + ], + 'BackupRetentionPeriod' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'BackupSize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '123124', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PreferredBackupPeriod\\": \\"Monday\\",\\n \\"Switch\\": \\"true\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PreferredBackupTime\\": \\"15:00Z-16:00Z\\",\\n \\"BackupRetentionPeriod\\": 7,\\n \\"BackupSize\\": \\"123124\\"\\n}","type":"json"}]', + 'title' => 'DescribeBackupPolicy', + ], + 'DeleteBackupPolicy' => [ + 'summary' => 'Deletes the backup policy of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseN8BUWF', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-xxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '60DDD29D-E5A8-563C-88FB-06D3A1F1C609', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"60DDD29D-E5A8-563C-88FB-06D3A1F1C609\\"\\n}","type":"json"}]', + 'title' => 'DeleteBackupPolicy', + ], + 'CreateBackupPolicy' => [ + 'summary' => 'Creates a backup policy for a specified ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cluster ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cc-2ze0eb0w182xh8549', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'PreferredBackupTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup time window within which the backup task is performed. The time is displayed in `UTC`. For example, `12:00Z-13:00Z` indicates that the backup time window ranges from `12:00` (UTC) to `13:00` `(UTC)`.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '10:00Z-11:00Z', + ], + ], + [ + 'name' => 'PreferredBackupPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The backup cycle, which indicates the day of the week when the system regularly backs up data. Separate multiple dates with commas (`,`).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Monday,Friday', + ], + ], + [ + 'name' => 'BackupRetentionPeriod', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of days for which you can retain the backup data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\"\\n}","type":"json"}]', + 'title' => 'CreateBackupPolicy', + ], + 'DescribeBackups' => [ + 'summary' => 'Queries the backup sets of an ApsaraDB for ClickHouse cluster that runs Enterprise Edition.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseIL81EM', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1v9kq45u0o80cvh', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'BackupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '117403****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-21T16:00Z', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-11-25T16:00Z', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '30', + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'string', + 'example' => '30', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F5178C10-1407-4987-9133-DE4DC9119F75', + ], + 'PageNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Items' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-bp179i5956tih2m93', + ], + 'BackupStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'BackupType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'IncrementalBackup', + ], + 'BackupStartTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-11-22T18:28:22Z', + ], + 'BackupSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '131072', + ], + 'BackupEndTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2021-11-22T18:28:41Z', + ], + 'BackupSetInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"shard_count"：4}', + ], + 'BackupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '117403****', + ], + 'BackupMethod' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Physical', + ], + 'ExpireDate' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2022-07-22T18:28:41Z', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": \\"1\\",\\n \\"PageSize\\": \\"30\\",\\n \\"RequestId\\": \\"F5178C10-1407-4987-9133-DE4DC9119F75\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Items\\": [\\n {\\n \\"DBInstanceId\\": \\"cc-bp179i5956tih2m93\\",\\n \\"BackupStatus\\": \\"Success\\",\\n \\"BackupType\\": \\"IncrementalBackup\\",\\n \\"BackupStartTime\\": \\"2021-11-22T18:28:22Z\\",\\n \\"BackupSize\\": 131072,\\n \\"BackupEndTime\\": \\"2021-11-22T18:28:41Z\\",\\n \\"BackupSetInfo\\": \\"{\\\\\\"shard_count\\\\\\": 4}\\",\\n \\"BackupId\\": \\"117403****\\",\\n \\"BackupMethod\\": \\"Physical\\",\\n \\"ExpireDate\\": \\"2022-07-22T18:28:41Z\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeBackups', + ], + 'ModifyDBInstanceConfig' => [ + 'summary' => '修改实例参数配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '206399', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6lkzf*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{"max_concurrent_queries":"100"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '05321590-BB65-4720-8C***********', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-uf6lkzf*****'."\n", + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05321590-BB65-4720-8C***********\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-uf6lkzf*****\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceConfigChangeLog' => [ + 'summary' => '查询实例参数配置记录', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '206401', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-uf6lkzf*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-01 10:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01-01 10:00:00'."\n", + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '30', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '780DE414-*********-88BE-A2E21B862B57', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'ParamChangeLogs' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ID' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'max_concurrent_queries', + ], + 'OldValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'NewValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + 'Applied' => [ + 'description' => '', + 'type' => 'boolean', + ], + 'GmtCreated' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-25 13:46:06', + ], + 'GmtModified' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2025-06-25 13:46:06'."\n", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"780DE414-*********-88BE-A2E21B862B57\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"ParamChangeLogs\\": [\\n {\\n \\"ID\\": 1,\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"OldValue\\": \\"50\\",\\n \\"NewValue\\": \\"100\\",\\n \\"Applied\\": true,\\n \\"GmtCreated\\": \\"2025-06-25 13:46:06\\",\\n \\"GmtModified\\": \\"2025-06-25 13:46:06\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DescribeDBInstanceConfig' => [ + 'summary' => '查询实例参数配置', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '204414', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-wz9go4x*****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '66428721-xxxx-xxxx-xxxx-3BD1B67837E0'."\n", + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cc-bp100p4q1g9z3****', + ], + 'Params' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'IsDynamic' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'IsUserModifiable' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'DefaultValue' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'max_concurrent_queries', + ], + 'Optional' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[0-100]', + ], + 'Comment' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Maximum number of concurrently executed queries. Zero means unlimited.', + ], + 'ParamRelyRule' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"66428721-xxxx-xxxx-xxxx-3BD1B67837E0\\\\n\\",\\n \\"Data\\": {\\n \\"DBInstanceId\\": \\"cc-bp100p4q1g9z3****\\",\\n \\"Params\\": [\\n {\\n \\"IsDynamic\\": 1,\\n \\"IsUserModifiable\\": 1,\\n \\"DefaultValue\\": \\"1\\",\\n \\"Name\\": \\"max_concurrent_queries\\",\\n \\"Optional\\": \\"[0-100]\\",\\n \\"Comment\\": \\"Maximum number of concurrently executed queries. Zero means unlimited.\\",\\n \\"ParamRelyRule\\": \\"0\\",\\n \\"Value\\": \\"100\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ChangeResourceGroup' => [ + 'summary' => '资源转组', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163948', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'EnterpriseDBCluster', + 'default' => 'EnterpriseDBCluster', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-bp1i43033051****', + ], + ], + [ + 'name' => 'ResourceRegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-4690g37929****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'C342F3DD-1FF7-55E9-A1A1-098D*******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.ResourceRegionId', + 'errorMessage' => 'The ResourceRegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C342F3DD-1FF7-55E9-A1A1-098D*******\\"\\n}","type":"json"}]', + ], + 'ListClickHouseDBTimezones' => [ + 'summary' => '列举ClickHouse时区参数枚举值', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseFBPCH8', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC', + ], + 'TimeZones' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ZoneId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D0CEC6AC-7760-409A-A0D5-E6CD8660E9CC\\",\\n \\"TimeZones\\": [\\n {\\n \\"ZoneId\\": \\"Asia/Shanghai\\"\\n }\\n ]\\n}","type":"json"}]', + ], + 'DeleteWhitelistTemplate' => [ + 'summary' => '删除白名单模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'example' => '98a6d3db05984dca', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DbInstanceName' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => null, + ], + 'CreateWhitelistTemplate' => [ + 'summary' => '新增白名单模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'InvoiceTemplate', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'formData', + 'schema' => [ + 'title' => '白名单列表. 逗号分隔，数量不超过100个。', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.1.1,10.0.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'description' => '', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'description' => '', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSecurityIPs.Malformed', + 'errorMessage' => 'Specified IPList is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateName.Duplicated', + 'errorMessage' => 'Whitelist template name duplicated.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', + 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Format', + 'errorMessage' => 'Specified security IP list format is not valid.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateName.CreateLimit', + 'errorMessage' => 'Created Whitelist template name exceeded limit.', + ], + [ + 'errorCode' => 'InvalidIpWhitelistTemplateName.Malformed', + 'errorMessage' => 'The templateName is not valid.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.Duplicate', + 'errorMessage' => 'Specified security IP list is not valid: Duplicate IP address in the list', + ], + [ + 'errorCode' => 'InvalidUser.NotFound', + 'errorMessage' => 'Specified user does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'DetachWhitelistTemplateToInstance' => [ + 'summary' => '取消白名单模板和实例关联关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库实例名。逗号分隔，一次关联变更不超过20个', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '操作状态。ok', + 'type' => 'string', + 'example' => 'ok', + ], + 'DetachFailList' => [ + 'title' => '解绑失败实例', + 'type' => 'array', + 'items' => [ + 'title' => '实例解绑失败详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Reason' => [ + 'title' => '解绑失败原因', + 'type' => 'string', + 'example' => '处理异常', + ], + ], + ], + ], + 'DetachSuccessedList' => [ + 'title' => '绑定成功模板', + 'type' => 'array', + 'items' => [ + 'title' => '实例绑定成功详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + [ + 'errorCode' => 'InvalidDBInstanceId.TooManyItems', + 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', + ], + [ + 'errorCode' => 'InvalidParameter.DBInstanceId', + 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'UpdateWhitelistTemplate' => [ + 'summary' => '更新白名单模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'SecurityIPList', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单列表. 逗号分隔，数量不超过100个。', + 'type' => 'string', + 'required' => true, + 'example' => '192.168.1.1,10.0.0.1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DbInstanceName' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidSecurityIPs.Malformed', + 'errorMessage' => 'Specified IPList is not valid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidSecurityIPList.QuotaExceeded', + 'errorMessage' => 'Specified security IP list is not valid: Exceeding the allowed amount of IP address in the list.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'GetWhitelistTemplate' => [ + 'summary' => '查询白名单模板详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'cc-asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'AttachWhitelistTemplateToInstance' => [ + 'summary' => '白名单模板关联实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'description' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'title' => '白名单模板Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '98a6d3db05984dca', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据库实例。逗号分隔，一次关联变更不超过20个', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-nkhdbf1d,cc-nkhdbf1s', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '操作状态。ok', + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'AttachFailList' => [ + 'title' => '解绑失败实例', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '实例解绑失败详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'description' => '', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Reason' => [ + 'title' => '解绑失败原因', + 'description' => '', + 'type' => 'string', + 'example' => '处理异常', + ], + ], + ], + ], + 'AttachSuccessedList' => [ + 'title' => '绑定成功模板', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '实例绑定成功详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例名称', + 'description' => '', + 'type' => 'string', + 'example' => 'my-database', + ], + 'Templates' => [ + 'title' => '白名单模板列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'description' => '', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'description' => '', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'description' => '', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'example' => 'asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplateId', + 'errorMessage' => 'Invalid Whitelist templateId.', + ], + [ + 'errorCode' => 'InvalidWhitelistTemplate.IllegalPermission', + 'errorMessage' => 'No permission to operate the whitelist template.', + ], + [ + 'errorCode' => 'InvalidDBInstanceId.TooManyItems', + 'errorMessage' => 'The number of DBInstanceId should be no more than 20.', + ], + [ + 'errorCode' => 'InvalidParameter.DBInstanceId', + 'errorMessage' => 'The specified parameter DBInstanceId is not valid.', + ], + [ + 'errorCode' => 'InvalidAttachTemplate.QuotaExceeded', + 'errorMessage' => 'Exceed the upper limit of the template that the instance can bind.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1234567890\\",\\n \\"Data\\": {\\n \\"Status\\": \\"ok\\",\\n \\"AttachFailList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Reason\\": \\"处理异常\\"\\n }\\n ],\\n \\"AttachSuccessedList\\": [\\n {\\n \\"DBInstanceId\\": \\"my-database\\",\\n \\"Templates\\": [\\n {\\n \\"TemplateId\\": \\"g-asdfwem\\",\\n \\"TemplateName\\": \\"demo_template\\",\\n \\"SecurityIPList\\": \\"192.168.1.1,10.0.0.1\\",\\n \\"DbInstances\\": [\\n {\\n \\"DBInstanceId\\": \\"asdfwef\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListWhitelistTemplates' => [ + 'summary' => '查询白名单模板清单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称，支持模糊查询', + 'type' => 'string', + 'example' => 'default', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页记录数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '25', + 'default' => '25', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '白名单模板清单结果', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'PageSize' => [ + 'title' => '分页数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'CurrPageNumbers' => [ + 'title' => '当前页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalPageNumbers' => [ + 'title' => '总页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'HasPrev' => [ + 'title' => '是否有前一页', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HasNext' => [ + 'title' => '是否有后一页', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + 'DbInstances' => [ + 'title' => '关联的实例列表', + 'type' => 'array', + 'items' => [ + 'title' => '实例详情', + 'type' => 'object', + 'properties' => [ + 'DBInstanceId' => [ + 'title' => '实例ID', + 'type' => 'string', + 'example' => 'cc-asdfwef', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + 'ListInstanceLinkedWhitelistTemplates' => [ + 'summary' => '查询实例关联的白名单模板清单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '185639', + 'abilityTreeNodes' => [ + 'FEATUREclickhouseCVENTL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'RegionId', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DBInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例名称', + 'type' => 'string', + 'required' => true, + 'example' => 'cc-exadfas', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + 'example' => '1234567890', + ], + 'Data' => [ + 'title' => '白名单模板清单结果', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'title' => '白名单模板列表', + 'type' => 'array', + 'items' => [ + 'title' => '模板详情', + 'type' => 'object', + 'properties' => [ + 'TemplateId' => [ + 'title' => '白名单模板ID', + 'type' => 'string', + 'example' => 'g-asdfwem', + ], + 'TemplateName' => [ + 'title' => '白名单模板名称', + 'type' => 'string', + 'example' => 'demo_template', + ], + 'SecurityIPList' => [ + 'title' => 'ip白名单列表', + 'type' => 'string', + 'example' => '192.168.1.1,10.0.0.1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'Invalid parameter.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'clickhouse.cn-qingdao.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'clickhouse.cn-zhangjiakou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'clickhouse.cn-huhehaote.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'clickhouse.cn-shenzhen.aliyuncs.com', + ], + [ + 'regionId' => 'cn-guangzhou', + 'endpoint' => 'clickhouse.cn-guangzhou.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'clickhouse.cn-chengdu.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'clickhouse.cn-hongkong.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'clickhouse.ap-northeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'clickhouse.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'clickhouse.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-6', + 'endpoint' => 'clickhouse.ap-southeast-6.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'clickhouse.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'clickhouse.eu-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'clickhouse.us-west-1.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'clickhouse.us-east-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-central-1', + 'endpoint' => 'clickhouse.me-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'clickhouse.cn-shanghai-finance-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'clickhouse.aliyuncs.com', + ], + ], +]; |