{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"DbConfig":{"description":"数据库配置。","properties":{"param_name":{"description":"参数名。","maxLength":1024,"minLength":2,"type":"string"},"value":{"description":"参数值。","maxLength":1024,"minLength":2,"type":"string"}},"type":"object"},"DbConfigCheckRequestV3":{"description":"HTAP库配置校验请求体。","properties":{"db_configs":{"description":"库配置列表。","items":{"$ref":"#/definitions/DbConfig"},"maxItems":1024,"minItems":0,"type":"array"},"source_database_name":{"description":"TaurusDB数据库名。","maxLength":1024,"minLength":3,"type":"string"},"source_instance_id":{"description":"TaurusDB实例ID。","maxLength":1024,"minLength":2,"type":"string"},"source_node_id":{"description":"TaurusDB只读节点ID。如为空,则取TaurusDB主节点ID","maxLength":1024,"minLength":0,"type":"string"},"table_repl_config":{"$ref":"#/definitions/TableReplConfig","description":"表配置信息。"},"target_database_name":{"description":"目标数据库名。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线_。","maxLength":128,"minLength":3,"type":"string"},"task_name":{"description":"同步任务名称。字符长度限制3~128位,仅支持英文大小写字母、数字以及下划线_。","maxLength":128,"minLength":3,"type":"string"}},"type":"object"},"DbConfigCheckResponseV3":{"description":"库配置校验响应。","properties":{"source_database_name":{"description":"TaurusDB数据库名称。","maxLength":1024,"minLength":2,"type":"string"},"source_db_config_check_results":{"description":"TaurusDB数据库配置检查结果。","items":{"$ref":"#/definitions/DbConfigCheckResult"},"maxItems":1024,"minItems":0,"type":"array"},"target_database_name":{"description":"目标数据库名称。","maxLength":128,"minLength":3,"type":"string"},"target_db_config_check_results":{"description":"目标数据库配置检查结果。","items":{"$ref":"#/definitions/DbConfigCheckResult"},"maxItems":5000,"minItems":0,"type":"array"},"task_name":{"description":"同步任务名称。","maxLength":128,"minLength":3,"type":"string"}},"type":"object"},"DbConfigCheckResult":{"description":"库配置校验检查结果。","properties":{"check_result":{"description":"校验结果。","enum":["success","fail"],"maxLength":1024,"minLength":1,"type":"string"},"param_name":{"description":"参数名。","maxLength":128,"minLength":2,"type":"string"},"value":{"description":"参数值。","maxLength":64,"minLength":1,"type":"string"}},"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"},"TableReplConfig":{"description":"表同步配置。","properties":{"repl_scope":{"default":"all","description":"表同步范围。all:全量同步,part:部分同步。","enum":["all","part"],"maxLength":5,"minLength":3,"type":"string"},"repl_type":{"description":"表同步类型。include_tables:白名单,exclude_tables:黑名单。","enum":["include_tables","exclude_tables"],"maxLength":15,"minLength":2,"type":"string"},"tables":{"description":"白名单或黑名单的表范围。","items":{"maxLength":1024,"minLength":2,"type":"string"},"maxItems":5000,"minItems":0,"type":"array"}},"type":"object"}},"description":null,"group_id":"1bf15763f8164608918d180a9b1aa137","host":"gaussdb.cn-north-4.myhuaweicloud.com","id":"77d3adc98e1e435bafef95a74ef4c0af","info_version":"v3","method":"post","name":"CheckDataBaseConfig","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check":{"post":{"description":"HTAP数据同步库配置校验。","operationId":"CheckDataBaseConfig","parameters":[{"description":"租户在某一Region下的project ID。\n\n获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-taurusdb/taurusdb_10_0004.html)。","in":"path","maxLength":1024,"minLength":2,"name":"project_id","required":true,"type":"string"},{"description":"数据同步创建任务请求体。","in":"body","name":"CheckDataBaseConfigRequestBody","required":true,"schema":{"$ref":"#/definitions/DbConfigCheckRequestV3"}},{"description":"用户Token。\n\n通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。\n\n请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。","in":"header","maxLength":1024,"minLength":2,"name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求语言类型。默认en-us。\n取值范围:\n- en-us\n- zh-cn","in":"header","name":"X-Language","required":true,"type":"string"},{"description":"StarRocks实例ID,严格匹配UUID规则。","in":"path","maxLength":1024,"minLength":2,"name":"instance_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Success.","examples":{"application/json":{"source_database_name":"source_database_name","source_db_config_check_results":[{"check_result":"success","param_name":"enable_chunk_level_dump","value":"false"},{"check_result":"success","param_name":"snapshot_with_lock","value":"true"}],"target_database_name":"","target_db_config_check_results":[]}},"schema":{"$ref":"#/definitions/DbConfigCheckResponseV3"}},"400":{"description":"Client error.","examples":{"application/json":{"error_code":"DBS.200022","error_msg":"实例不存在"}},"schema":{"$ref":"#/definitions/ErrorRsp"}},"500":{"description":"Server error.","schema":{"$ref":"#/definitions/ErrorRsp"}}},"summary":"HTAP数据同步库配置校验","tags":["HTAP-标准版"],"x-apigateway-ratelimit":"gaussdbformysql01","x-is-registered":"Y","x-request-examples-1":{"db_configs":[{"param_name":"enable_chunk_level_dump","value":"false"},{"param_name":"snapshot_with_lock","value":"true"},{"param_name":"sync_commit_interval_ms","value":"5000"},{"param_name":"max_sync_commit_rows","value":"500000"},{"param_name":"max_sync_commit_bytes","value":"268435456"},{"param_name":"max_full_sync_task_threads_num","value":"1"},{"param_name":"max_rows_per_chunk","value":"0"},{"param_name":"max_bytes_per_chunk","value":"268435456"},{"param_name":"binlog_expire_logs_seconds","value":"0"}],"source_database_name":"source_database_name","source_instance_id":"source_instance_id","source_node_id":"source_node_id","table_replconfig":{"repl_scope":"all","repl_type":"include_tables","tables":[]},"target_database_name":"target_database_name"},"x-request-examples-text-1":{"db_configs":[{"param_name":"enable_chunk_level_dump","value":"false"},{"param_name":"snapshot_with_lock","value":"true"},{"param_name":"sync_commit_interval_ms","value":"5000"},{"param_name":"max_sync_commit_rows","value":"500000"},{"param_name":"max_sync_commit_bytes","value":"268435456"},{"param_name":"max_full_sync_task_threads_num","value":"1"},{"param_name":"max_rows_per_chunk","value":"0"},{"param_name":"max_bytes_per_chunk","value":"268435456"},{"param_name":"binlog_expire_logs_seconds","value":"0"}],"source_database_name":"source_database_name","source_instance_id":"source_instance_id","source_node_id":"source_node_id","table_replconfig":{"repl_scope":"all","repl_type":"include_tables","tables":[]},"target_database_name":"target_database_name"},"x-request-examples-url-1":"POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-config-check","x-support-sdk":"Y"}}},"product_short":"GaussDB","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"HTAP数据同步库配置校验","tags":"HTAP-标准版","uri":null,"version":"2.0"}