华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 source_instance_id String 源实例ID。 source_node_id String 源实例节点ID。 database_info ChDatabaseConfigResponse object 数据库配置信息。 table_infos Array of ChDatabaseTableConfigCheckResult objects 表配置信息。 table_repl_config ChDatabaseTableReplConfigInfo object 表同步配置信息。 is_tables_change Boolean 同步任务表是否变化。 new_table_repl_config ChDatabaseTableReplConfigInfo object 更新的表同步配置信息。 last_error_of_alter_table String 最近一次alter table的异常信息。 表5 ChDatabaseConfigResponse 参数 参数类型 描述 database_name String 源数据库名称。 db_config_check_results Array of ChDatabaseConfigCheckResult objects 源数据库配置检查结果。 表6 ChDatabaseConfigCheckResult 参数 参数类型 描述 param_name String 库同步配置参数名。 value String 库同步配置参数值。 check_result String 校验结果。 取值范围： success：成功 fail：失败 表7 ChDatabaseTableConfigCheckResult 参数 参数类型 描述 table_name String 数据库表名。 table_config String 表配置项。 允许输入的列操作有：PARTITION BY, COLUMNS, ORDER BY, SAMPLE BY, PRIMARY KEY, TTL check_result String 校验结果。 表8 ChDatabaseTableReplConfigInfo 参数 参数类型 描述 repl_type String 表同步类型。 取值范围： white_list：白名单，此时表范围不能为空。 black_list：黑名单，此时表范围为空则选择所有表。 tables Array of strings 白名单或黑名单的表范围。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "source_instance_id" : "77aa4096cb824a61b93dab5ca00ecc8fin07", "source_node_id" : "57bfeacf6e8d4eb685ea907372374b35no07", "database_info" : { "database_name" : "blackwhite_0018_61474479", "db_config_check_results" : [ { "param_name" : "default_isolation_level", "value" : "QUERY_SNAPSHOT", "check_result" : "success" }, { "param_name" : "enable_snapshots", "value" : "true", "check_result" : "success" }, { "param_name" : "enable_chunk_level", "value" : "true", "check_result" : "success" }, { "param_name" : "max_sync_threads", "value" : "1", "check_result" : "success" }, { "param_name" : "treat_numeric_string_as_integer", "value" : "false", "check_result" : "success" }, { "param_name" : "min_binlog_expire_logs_seconds", "value" : "86400", "check_result" : "success" }, { "param_name" : "max_rows_in_buffer", "value" : "2000000", "check_result" : "success" }, { "param_name" : "max_rows_in_buffers", "value" : "6000000", "check_result" : "success" }, { "param_name" : "max_bytes_in_buffer", "value" : "200000000", "check_result" : "success" }, { "param_name" : "max_bytes_in_buffers", "value" : "600000000", "check_result" : "success" }, { "param_name" : "max_flush_data_time", "value" : "5000", "check_result" : "success" } ] }, "table_infos" : [ ], "table_repl_config" : { "repl_type" : "black_list", "tables" : [ ] }, "is_tables_change" : false, "new_table_repl_config" : { "repl_type" : null, "tables" : null }, "last_error_of_alter_table" : null }

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

请求示例 修改数据库用户的备注。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/comment { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "comment" : "first_database_user" } ] }

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 job_id String 修改数据库用户备注的任务ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "proxy_flavor_groups" : [ { "group_type" : "X86", "proxy_flavors" : [ { "id" : "19be4c5d-d363-3342-bdbc-0dd9dbf7fafe", "spec_code" : "gaussdb.proxy.large.x86.2", "vcpus" : 2, "ram" : 4, "db_type" : "Proxy", "az_status" : { "az1" : "normal" } } ] } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 proxy_flavor_groups Array of MysqlProxyFlavorGroups objects 规格组信息。 表4 MysqlProxyFlavorGroups 参数 参数类型 描述 group_type String 规格组类型，如x86、arm。 proxy_flavors Array of MysqlProxyComputeFlavor objects 规格信息。 表5 MysqlProxyComputeFlavor 参数 参数类型 描述 vcpus String CPU大小。例如：1表示1U。 ram String 内存大小，单位为GB。 db_type String 数据库类型。 id String 数据库代理规格ID。 spec_code String 数据库代理规格码。 az_status Object 其中key是可用区编号，value是规格所在AZ的状态。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 instance_id String 实例ID，严格匹配UUID规则。 node_names Array of strings 节点名称列表。 job_id String 创建只读节点的任务ID。 仅创建按需只读节点时会返回该参数。 order_id String 订单号，创建包年包月只读节点时返回该参数。 状态码： 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参数 参数 是否必选 参数类型 描述 priorities 是 Array of integers 指定创建的只读节点故障倒换优先级。 故障倒换优先级的取值范围为1~16，数字越小，优先级越大，即故障倒换时，主节点会优先倒换到优先级高的只读节点上，优先级相同的只读节点选为主节点的概率相同。最多支持9个只读节点设置故障倒换优先级，超过9个的只读节点优先级默认为-1，表示不会参与倒换。可通过修改节点的故障倒换优先级来进行调整。 is_auto_pay 否 String 创建包年/包月实例时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true：为自动支付，默认该方式。 false：为手动支付。 availability_zones 否 Array of strings 可用区。可指定可用区创建只读节点，不传该参数时默认为自动选择可用区。 该参数目前处于公测阶段，如需使用，请提交工单联系客服人员申请权限。 调用查询数据库规格获取，其中az_status中的key为availability_zone。 注：指定可用区创建只读节点，可能由于资源不足创建失败。

请求示例 授予数据库用户数据库读写权限。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/privilege { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "databases" : [ { "name" : "test", "readonly" : false } ] } ] } 授予数据库用户数据库只读权限。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/privilege { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "databases" : [ { "name" : "test", "readonly" : 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参数 参数 是否必选 参数类型 描述 users 是 Array of GrantDatabasePermission objects 数据库用户列表，列表最大长度为50。 表4 GrantDatabasePermission 参数 是否必选 参数类型 描述 name 是 String 数据库用户名。 host 是 String 主机地址。 databases 是 Array of DatabasePermission objects 数据库权限列表，列表最大长度为50。 表5 DatabasePermission 参数 是否必选 参数类型 描述 name 是 String 数据库名称。 readonly 是 Boolean 是否为只读权限： true：表示只读。 false：表示可读写。

响应参数 状态码： 201 表6 响应Body参数 参数 参数类型 描述 job_id String 授予用户权限的任务ID。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应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参数 参数 是否必选 参数类型 描述 dns_type 是 String 域名 类型，当前只支持private。

响应参数 状态码： 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 错误消息。

响应示例 状态码： 200 Success. { "total_count" : 2, "instances" : [ { "id" : "090e539b45e047ee9cc17750b321ef7ein07", "name" : "gauss-dd-single", "ha_mode" : "StandSingle", "engine_name" : "taurus", "engine_version" : "2.0.51.240300", "pay_model" : "0", "create_at" : 1712656933705, "deleted_at" : 1712659228276, "volume_type" : "", "volume_size" : "0", "data_vip" : "172.16.1.234", "data_vip_ipv6" : null, "enterprise_project_id" : "0", "enterprise_project_name" : "default", "backup_level" : "2", "recycle_backup_id" : "c62e218ccd6c49098baa925453c65e29br07", "recycle_status" : "Active" }, { "id" : "632423cc56c348bd967b3a03e7abdab9in07", "name" : "gauss-dd-single", "ha_mode" : "StandSingle", "engine_name" : "taurus", "engine_version" : "2.0.51.240300", "pay_model" : "0", "create_at" : 1712658210524, "deleted_at" : 1712659158927, "volume_type" : "", "volume_size" : "0", "data_vip" : "172.16.1.194", "data_vip_ipv6" : null, "enterprise_project_id" : "0", "enterprise_project_name" : "default", "backup_level" : "2", "recycle_backup_id" : "70d03dc459304f7298c0f5b49286f37cbr07", "recycle_status" : "Active" } ] }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count String 数据总数 instances Array of RecycleInstanceV3 objects 回收站实例信息 表5 RecycleInstanceV3 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 ha_mode String 实例类型。 engine_name String 引擎名称。 engine_version String 引擎版本。 pay_model String 计费模式。 create_at Integer 创建时间。 deleted_at Integer 删除时间。 volume_type String 磁盘类型。 volume_size String 磁盘大小。 data_vip String 数据面VIP。 data_vip_ipv6 String 数据面IPV6。 enterprise_project_id String 企业项目ID。 enterprise_project_name String 企业项目名称。 backup_level String 备份级别。 recycle_backup_id String 备份ID。 recycle_status String 回收状态。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/instances/recycle-info 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 查询记录数。默认为10，不能为负数，最小值为1，最大值为100。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 session_consistence 是 String 会话一致性。 取值范围： true：时表示会话一致性开启。 false：时表示会话一致性关闭。 consistence_mode 否 String 一致性模式。默认值为空，此时以会话一致性参数session_consistence的值为准。 取值范围： session: 会话一致性（当session_consistence为true时，只能取该值）。 global: 全局一致性（当session_consistence为false时，可取该值）。 eventual: 最终一致性（当session_consistence为false时，可取该值）。

请求示例 开启数据库代理的会话一致性。 PUT https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/d512257ecca04d96a0f3a9021018a385in07/proxy/7bf4a8bbb4f4fb58233a242ee13603bpo01/session-consistence { "session_consistence" : "true", "consistence_mode" : "session" }

URI PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/session-consistence 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理ID，严格匹配UUID规则。

响应参数 状态码： 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 错误消息。

请求示例 POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication/database-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" : [ ] }, "source_instance_id" : "source_instance_id", "source_node_id" : "source_node_id" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 source_database_name String 目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线_。 source_db_config_check_results Array of DbConfigCheckResult objects TaurusDB数据库配置检查结果。 target_database_name String 目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 target_db_config_check_results Array of DbConfigCheckResult objects 目标数据库配置检查结果。 task_name String 同步任务名称。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 表7 DbConfigCheckResult 参数 参数类型 描述 param_name String 参数名，字符长度限制3~128位。 value String 参数值，字符长度限制1~64位。 check_result String 校验结果。 可选范围 success fail 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 Success. { "source_database_name" : "source_database_name", "target_database_name" : "", "source_db_config_check_results" : [ { "param_name" : "enable_chunk_level_dump", "value" : "false", "check_result" : "success" }, { "param_name" : "snapshot_with_lock", "value" : "true", "check_result" : "success" } ], "target_db_config_check_results" : [ ] } 状态码： 400 Client error. { "error_code" : "DBS.200022", "error_msg" : "实例不存在" }

请求参数 表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位，仅支持英文大小写字母、数字以及下划线。 target_database_name 否 String 目标数据库名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 task_name 否 String 同步任务名称。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 db_configs 否 Array of DbConfig objects 库配置列表。 table_repl_config 否 TableReplConfig object 表配置信息。 表4 DbConfig 参数 是否必选 参数类型 描述 param_name 否 String 参数名。 value 否 String 参数值。 表5 TableReplConfig 参数 是否必选 参数类型 描述 repl_type 否 String 表同步类型。include_tables：白名单，exclude_tables：黑名单。 repl_scope 否 String 表同步范围。all：全量同步，part：部分同步。 tables 否 Array of strings 白名单或黑名单的表范围。

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

请求示例 删除主机地址是"127.0.0.1"的数据库用户。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 users 是 Array of ListDeleteDatabaseUserRequest objects 准备删除的数据库用户列表，列表最大长度为50。 表4 ListDeleteDatabaseUserRequest 参数 是否必选 参数类型 描述 name 是 String 数据库用户名。 host 是 String 主机地址。

响应参数 状态码： 202 表5 响应Body参数 参数 参数类型 描述 job_id String 删除数据库用户的任务ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。