{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"ChDatabaseConfigsInfo":{"description":"库配置列表。","properties":{"param_name":{"description":"库同步配置参数名。可通过“查询ClickHouse数据同步的库参数配置”接口查询。","type":"string"},"value":{"description":"库同步配置参数值。","type":"string"}},"required":["param_name","value"],"type":"object"},"ChDatabaseTableConfigCheckResult":{"description":"表配置校验结果。","properties":{"check_result":{"description":"校验结果。","type":"string"},"table_config":{"description":"表配置项。\n\n允许输入的列操作有:PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY, TTL","type":"string"},"table_name":{"description":"数据库表名。","type":"string"}},"required":["table_name","table_config","check_result"],"type":"object"},"ChDatabaseTableConfigResponse":{"description":"表配置校验返回体。","properties":{"source_database_name":{"description":"源数据库名。","type":"string"},"table_config_check_results":{"description":"表配置检查结果。","items":{"$ref":"#/definitions/ChDatabaseTableConfigCheckResult"},"type":"array"}},"required":["source_database_name","table_config_check_results"],"type":"object"},"ChDatabaseTableReplConfigInfo":{"description":"表配置信息。","properties":{"repl_type":{"description":"表同步类型。\n取值范围:\n- white_list:白名单,此时表范围不能为空。\n- black_list:黑名单,此时表范围为空则选择所有表。","type":"string"},"tables":{"description":"白名单或黑名单的表范围。","items":{"type":"string"},"type":"array"}},"required":["repl_type","tables"],"type":"object"},"ChDatabaseTablesConfigsInfo":{"description":"表配置。","properties":{"table_config":{"description":"表配置值。\n\n允许输入的列操作有:PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY, TTL","type":"string"},"table_name":{"description":"数据库表名。","type":"string"}},"required":["table_name","table_config"],"type":"object"},"CheckChDatabaseTableConfigRequestBody":{"description":"表配置校验请求体。","properties":{"db_configs":{"description":"库配置列表。","items":{"$ref":"#/definitions/ChDatabaseConfigsInfo"},"type":"array"},"source_database_name":{"description":"源数据库名。","type":"string"},"source_instance_id":{"description":"源实例ID。","type":"string"},"source_node_id":{"description":"源节点ID。TaurusDB只读节点ID。如为空,则取TaurusDB主节点ID。","type":"string"},"table_repl_config":{"$ref":"#/definitions/ChDatabaseTableReplConfigInfo","description":"表同步配置信息。"},"tables_configs":{"description":"表配置信息。","items":{"$ref":"#/definitions/ChDatabaseTablesConfigsInfo"},"type":"array"}},"required":["source_instance_id","source_database_name","db_configs","tables_configs","table_repl_config"],"type":"object"},"ErrorRsp":{"description":"失败时返回的错误对象","properties":{"error_code":{"description":"错误码。","example":"DBS.280292","type":"string"},"error_msg":{"description":"错误描述。","example":"数据库用户名非法","type":"string"}},"required":["error_code","error_msg"],"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"1cfa2a1f93da44c583a2269058dc7993","info_version":"v3","method":"post","name":"CheckClickHouseTableConfig","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/clickhouse/replication/table-check":{"post":{"description":"数据同步表配置校验。","operationId":"CheckClickHouseTableConfig","parameters":[{"description":"租户在某一Region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。","in":"path","name":"project_id","required":true,"type":"string"},{"description":"ClickHouse实例ID,严格匹配UUID规则。","in":"path","name":"instance_id","required":true,"type":"string"},{"description":"表配置校验请求体。","in":"body","name":"CheckClickHouseTableConfigRequestBody","required":true,"schema":{"$ref":"#/definitions/CheckChDatabaseTableConfigRequestBody"}},{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"source_database_name":"blackwhite_0017_22525694","table_config_check_results":[{"check_result":"Check Override Table Failed","table_config":"ORDER BY id","table_name":"sbtest100"}]}},"schema":{"$ref":"#/definitions/ChDatabaseTableConfigResponse"}},"400":{"description":"Client error.","schema":{"$ref":"#/definitions/ErrorRsp"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorRsp"}}},"summary":"数据同步表配置校验","tags":["HTAP-轻量版"],"x-is-registered":"Y","x-request-examples-1":{"db_configs":[{"param_name":"default_isolation_level","value":"QUERY_SNAPSHOT"},{"param_name":"enable_snapshots","value":"true"},{"param_name":"enable_chunk_level","value":"true"},{"param_name":"max_sync_threads","value":"1"},{"param_name":"treat_numeric_string_as_integer","value":"false"},{"param_name":"min_binlog_expire_logs_seconds","value":"86400"},{"param_name":"max_rows_in_buffer","value":"2000000"},{"param_name":"max_rows_in_buffers","value":"6000000"},{"param_name":"max_bytes_in_buffer","value":"200000000"},{"param_name":"max_bytes_in_buffers","value":"600000000"},{"param_name":"max_flush_data_time","value":"5000"}],"source_database_name":"blackwhite_0017_22525694","source_instance_id":"77aa4096cb824a61b93dab5ca00ecc8fin07","source_node_id":"57bfeacf6e8d4eb685ea907372374b35no07","table_repl_config":{"repl_type":"white_list","tables":[]},"tables_configs":[{"table_config":"ORDER BY id","table_name":"sbtest100"}]},"x-request-examples-description-1":"数据同步表配置校验。","x-request-examples-text-1":{"db_configs":[{"param_name":"default_isolation_level","value":"QUERY_SNAPSHOT"},{"param_name":"enable_snapshots","value":"true"},{"param_name":"enable_chunk_level","value":"true"},{"param_name":"max_sync_threads","value":"1"},{"param_name":"treat_numeric_string_as_integer","value":"false"},{"param_name":"min_binlog_expire_logs_seconds","value":"86400"},{"param_name":"max_rows_in_buffer","value":"2000000"},{"param_name":"max_rows_in_buffers","value":"6000000"},{"param_name":"max_bytes_in_buffer","value":"200000000"},{"param_name":"max_bytes_in_buffers","value":"600000000"},{"param_name":"max_flush_data_time","value":"5000"}],"source_database_name":"blackwhite_0017_22525694","source_instance_id":"77aa4096cb824a61b93dab5ca00ecc8fin07","source_node_id":"57bfeacf6e8d4eb685ea907372374b35no07","table_repl_config":{"repl_type":"white_list","tables":[]},"tables_configs":[{"table_config":"ORDER BY id","table_name":"sbtest100"}]},"x-request-examples-url-1":"POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/table-check","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"数据同步表配置校验","tags":"HTAP-轻量版","uri":null,"version":"2.0"}