华为云用户手册

请求示例 数据同步库配置校验。 POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/database-check{ "source_database_name" : "blackwhite_0018_61474479", "db_configs" : [ { "param_name" : "default_isolation_level", "value" : "QUERY_SNAPSHOT" } ], "table_repl_config" : { "repl_type" : "black_list", "tables" : [ ] }, "source_instance_id" : "77aa4096cb824a61b93dab5ca00ecc8fin07", "source_node_id" : "57bfeacf6e8d4eb685ea907372374b35no07"}

URI POST /v3/{project_id}/instances/{instance_id}/clickhouse/replication/database-check 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例ID，严格匹配UUID规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 source_instance_id 是 String 源实例ID，严格匹配UUID规则。 source_node_id 否 String 源节点ID。TaurusDB只读节点ID。如为空，则取TaurusDB主节点ID。 source_database_name 是 String 源数据库名。 db_configs 是 Array of ChDatabaseConfigsInfo objects 库配置列表。 table_repl_config 是 ChDatabaseTableReplConfigInfo object 表配置信息。 表4 ChDatabaseConfigsInfo 参数 是否必选 参数类型 描述 param_name 是 String 库同步配置参数名。可通过“查询数据同步的库参数配置”接口查询。 value 是 String 库同步配置参数值。 表5 ChDatabaseTableReplConfigInfo 参数 是否必选 参数类型 描述 repl_type 是 String 表同步类型。 取值范围： white_list：白名单，此时表范围不能为空。 black_list：黑名单，此时表范围为空则选择所有表。 tables 是 Array of strings 白名单或黑名单的表范围。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 source_instance_id 否 String TaurusDB实例ID。 source_node_id 否 String TaurusDB只读节点ID。 source_database_name 否 String TaurusDB数据库名。字符长度限制3~1024位，仅支持英文大小写字母、数字以及下划线。 task_name 否 String 同步任务名称。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 db_configs 否 Array of DbConfig objects 库配置列表。 tables_configs 否 Array of TablesConfig objects 表配置信息。 table_repl_config 否 TableReplConfig object 表同步配置信息。 target_database_name 否 String 目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 is_create_task 否 String 是否创建同步任务 表4 DbConfig 参数 是否必选 参数类型 描述 param_name 否 String 参数名。 value 否 String 参数值。 表5 TablesConfig 参数 是否必选 参数类型 描述 table_name 否 String 表名。 table_config 否 String 表配置值。 表6 TableReplConfig 参数 是否必选 参数类型 描述 repl_type 否 String 表同步类型。include_tables：白名单，exclude_tables：黑名单。 repl_scope 否 String 表同步范围。all：全量同步，part：部分同步。 tables 否 Array of strings 白名单或黑名单的表范围。

请求示例 POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/table-config-check{ "source_database_name" : "source_database_name", "target_database_name" : "target_database_name", "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" } ], "table_repl_config" : { "repl_type" : "include_tables", "repl_scope" : "all", "tables" : [ ] }, "tables_configs" : { "table_name" : "tableName", "table_config" : "tableConfig" }, "source_instance_id" : "source_instance_id", "is_create_task" : "true", "source_node_id" : "source_node_id"}

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 source_database_name String TaurusDB数据库名。字符长度限制3~1024位，仅支持英文大小写字母、数字以及下划线。 target_database_name String 目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 tbl_config_check_results Array of TableConfigCheckResult objects 表配置检查结果。 task_name String 同步任务名称。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 表8 TableConfigCheckResult 参数 参数类型 描述 table_name String 表名 table_config String 表配置项 check_result String 校验结果，success/failed 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "source_database_name" : "source_database_name", "target_database_name" : "", "task_name" : "task", "tbl_config_check_results" : [ { "table_name" : "table", "table_config" : "order by id", "check_result" : "success" } ]} 状态码： 400 Client error. { "error_code" : "DBS.200022", "error_msg" : "实例不存在"}

URI POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/table-config-check 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID，严格匹配UUID规则。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 校验类型。 createInstance：校验创建实例。 createReadonlyNode：校验创建只读节点。 resizeFlavor：校验规格变更。 resource 是 CheckResourceInfo object 资源信息。 表4 CheckResourceInfo 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 企业项目ID。action为createInstance时必填。 instance_num 否 Integer 实例数量。action为createInstance时必填。 mode 否 String 实例类型，目前仅支持Cluster。action为createInstance时必填。 availability_zone_mode 否 String 可用区类型，单可用区single或多可用区multi。action为createInstance时必填。 node_num 否 Integer 节点数量。action为createInstance、createReadonlyNode时必填。 flavor_ref 否 String 规格码。action为createInstance、resizeFlavor时必填。 availability_zone 否 String 可用区码。 subnet_id 否 String 子网ID。action为createInstance时必填。 instance_id 否 String 实例ID。action为createReadonlyNode、resizeFlavor时必填。

请求示例 创建实例资源预校验。 POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check{ "action" : "createInstance", "resource" : { "enterprise_project_id" : 0, "instance_num" : 1, "mode" : "Cluster", "availability_zone_mode" : "single", "node_num" : 2, "flavor_ref" : "gaussdb.mysql.xlarge.x86.4", "availability_zone" : "cn-southwest-244b", "subnet_id" : "1e9f71dd-9192-4c0d-9739-161d8dcca68c" }} 添加只读资源预校验。 POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check{ "action" : "createReadonlyNode", "resource" : { "instance_id" : "376e0847a2224e95afcd3e607eccd544in07", "node_num" : 1 }} 规格变更资源预校验。 POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/resource-check{ "action" : "resizeFlavor", "resource" : { "instance_id" : "376e0847a2224e95afcd3e607eccd544in07", "flavor_ref" : "gaussdb.mysql.xlarge.x86.4" }}

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result Boolean 结果。 true：表示通过。 false：表示不通过。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result Boolean 检查结果。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 StarRocks实例资源检查 POST https://{endpoint}/v3/8f26bcbd59e84e1d9e0569c32545cee9/starrocks/resource-check{ "action" : "createInstance", "resource" : { "instance_num" : 1, "mode" : "Cluster", "availability_zone_mode" : "single", "fe_node_num" : 3, "be_node_num" : 3, "fe_flavor_ref" : "gaussdb.sr-fe.8xlarge.x86.4", "be_flavor_ref" : "gaussdb.sr-be.8xlarge.x86.4", "availability_zone" : "cn-southwest-244a", "subnet_id" : "b00dc497-91e1-4082-aeb0-a1dc95e10371", "enterprise_project_id" : "0" }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 校验类型，仅支持校验创建实例。 resource 是 resource object 资源信息。 表4 resource 参数 是否必选 参数类型 描述 enterprise_project_id 是 String 企业项目ID。 instance_num 是 Integer 实例数量。 mode 是 String 实例部署模式。 availability_zone_mode 是 String 可用区类型，目前仅支持single。 fe_node_num 是 Integer FE节点数量。 be_node_num 是 Integer BE节点数量。 fe_flavor_ref 是 String FE规格码。 be_flavor_ref 是 String BE规格码。 availability_zone 否 String 可用区码。选填，校验可用区码是否正确。 subnet_id 是 String HTAP实例子网即TaurusDB实例子网。 获取方法请参见获取子网ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 differences Array of ParamGroupParameterDifferences objects 老本版参数之间区别的集合。 表5 ParamGroupParameterDifferences 参数 参数类型 描述 parameter_name String 参数名称。 source_value String 源参数模板中的参数值。 target_value String 目标参数模板中的参数值。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn Content-Type 是 String 内容类型。 取值：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 source_configuration_id 是 String 需要进行比较的源参数模板ID。通过ListStarrocksInstanceInfo接口获得。

请求示例 数据同步表配置校验。 POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication/table-check{ "source_database_name" : "blackwhite_0017_22525694", "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" } ], "tables_configs" : [ { "table_name" : "sbtest100", "table_config" : "ORDER BY id" } ], "table_repl_config" : { "repl_type" : "white_list", "tables" : [ ] }, "source_instance_id" : "77aa4096cb824a61b93dab5ca00ecc8fin07", "source_node_id" : "57bfeacf6e8d4eb685ea907372374b35no07"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 source_instance_id 是 String 源实例ID。 source_node_id 否 String 源节点ID。TaurusDB只读节点ID。如为空，则取TaurusDB主节点ID。 source_database_name 是 String 源数据库名。 db_configs 是 Array of ChDatabaseConfigsInfo objects 库配置列表。 tables_configs 是 Array of ChDatabaseTablesConfigsInfo objects 表配置信息。 table_repl_config 是 ChDatabaseTableReplConfigInfo object 表同步配置信息。 表4 ChDatabaseConfigsInfo 参数 是否必选 参数类型 描述 param_name 是 String 库同步配置参数名。可通过“查询数据同步的库参数配置”接口查询。 value 是 String 库同步配置参数值。 表5 ChDatabaseTablesConfigsInfo 参数 是否必选 参数类型 描述 table_name 是 String 数据库表名。 table_config 是 String 表配置值。 允许输入的列操作有：PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY, TTL 表6 ChDatabaseTableReplConfigInfo 参数 是否必选 参数类型 描述 repl_type 是 String 表同步类型。 取值范围： white_list：白名单，此时表范围不能为空。 black_list：黑名单，此时表范围为空则选择所有表。 tables 是 Array of strings 白名单或黑名单的表范围。

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 source_database_name String 源数据库名。 table_config_check_results Array of ChDatabaseTableConfigCheckResult objects 表配置检查结果。 表8 ChDatabaseTableConfigCheckResult 参数 参数类型 描述 table_name String 数据库表名。 table_config String 表配置项。 允许输入的列操作有：PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY, TTL check_result String 校验结果。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "source_database_name" : "blackwhite_0017_22525694", "table_config_check_results" : [ { "table_name" : "sbtest100", "table_config" : "ORDER BY id", "check_result" : "Check Override Table Failed" } ]}

URI POST /v3/{project_id}/instances/{instance_id}/clickhouse/replication/table-check 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String ClickHouse实例ID，严格匹配UUID规则。

请求示例 查询时间段内（2022-07-06~2022-07-16）的增量备份列表。 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/incremental-backups?offset=0&limit=10&begin_time=2022-07-06T10:41:14+0800&end_time=2022-07-16T10:41:14+0800

URI GET /v3/{project_id}/instances/{instance_id}/incremental-backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 String 查询记录数。默认为10，可取范围：10、20、50。 begin_time 否 String 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 “begin_time”有值时，“end_time”必选。 end_time 否 String 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 “end_time”有值时，“begin_time”必选。

响应示例 状态码： 200 Success. { "backups" : [ { "id" : "f0d2aea28d26t4848b8c84ed3fea1822fbr07", "name" : " GaussDB forMySQL--20230728181555006", "begin_time" : "2022-07-07T12:41:14+0800", "end_time" : "2022-07-08T12:45:14+0800", "size" : 0.109375, "instance_id" : "61a4ea66210545909d74a05c27a7179ein07" } ], "total_count" : 1}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backups Array of IncrementalBackups objects 备份信息。 total_count Long 备份文件的总数。 表5 IncrementalBackups 参数 参数类型 描述 id String 备份ID。 name String 备份名称。 begin_time String 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time String 备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 size Number 备份大小，(单位：KB)。 instance_id String 实例ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 修改实例名称的任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。取值范围：最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 is_modify_node_name 否 String 是否同步修改节点名称，取值：true或false, 默认值为true。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 flavor_ref 是 String 需要变更的新规格ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 变更数据库代理的规格为4U8GB。 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/61a4ea66210545909d74a05c27a7179ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/flavor{ "flavor_ref" : "gaussdb.proxy.xlarge.arm.2"}