华为云用户手册

响应参数 状态码： 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 表5 响应Body参数 参数 参数类型 描述 instance_id String 实例ID。 instance_name String 实例名称。 switch_status AutoScalingSwitchStatus object 开关状态。 表6 AutoScalingSwitchStatus 参数 参数类型 描述 scaling_switch String 自动变配开关状态。 取值： ON：开启。 OFF：关闭。 flavor_switch String 扩缩规格开关状态。 取值： ON：开启。 OFF：关闭。 read_only_switch String 增删只读节点开关状态。 取值： ON：开启。 OFF：关闭。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 设置自动变配。 PUT https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/auto-scaling/policy { "enlarge_threshold" : 50, "max_flavor" : "gaussdb.mysql.large.x86.4", "max_read_only_count" : 2, "monitor_cycle" : 300, "read_only_weight" : 10, "reduce_enabled" : false, "scaling_strategy" : { "flavor_switch" : "ON", "read_only_switch" : "ON" }, "silence_cycle" : 300, "status" : "ON" }

响应示例 状态码： 200 Success. { "instance_id" : "61a4ea66210545909d74a05c27a7179ein07", "instance_name" : "gauss-test-1", "switch_status" : { "scaling_switch" : "ON", "flavor_switch" : "ON", "read_only_switch" : "ON" } }

请求参数 表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参数 参数 是否必选 参数类型 描述 status 是 String 自动变配开关状态。 取值： ON：开启。 OFF：关闭。 scaling_strategy 是 ScalingStrategyReqInfo object 自动变配策略。 monitor_cycle 否 Integer 监测周期（单位：秒）。 在整个观测窗口期内，若CPU平均使用率大于等于设定值，则在观测窗口结束后，进行扩容。 取值范围：300、600、900、1800。 status为ON时必填。 silence_cycle 否 Integer 静默周期（单位：秒）。 两次自动扩容或自动回缩的最小间隔时间。 取值范围：300、600、1800、3600、7200、10800、86400、604800。 status为ON时必填。 enlarge_threshold 否 Integer CPU平均使用率（百分比数值）。 取值范围：50-100。 status为ON时必填。 max_flavor 否 String 扩容规格上限。开启扩缩规格时必填。 reduce_enabled 否 Boolean 是否开启自动回缩。开启自动变配时必填。 true：是。 false：否。 max_read_only_count 否 Integer 只读节点数量上限。开启增删只读节点时必填。 read_only_weight 否 Integer 只读节点读写分离权重。开启增删只读节点时必填。 表4 ScalingStrategyReqInfo 参数 是否必选 参数类型 描述 flavor_switch 是 String 扩缩规格开关。 ON：开启。 OFF：关闭。 read_only_switch 是 String 增删只读节点开关。自动增删只读节点功能需要先开启数据库代理，且只能有一个代理。 ON：开启。 OFF：关闭。

请求示例 修改数据库用户“gaussdb_mysql_user1”的密码。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users/password { "users" : [ { "name" : "gaussdb_mysql_user1", "host" : "127.0.0.1", "password" : "***" } ] }

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

请求参数 表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 ResetDatabasePassword objects 准备修改密码的数据库用户列表，列表最大长度为50。 表4 ResetDatabasePassword 参数 是否必选 参数类型 描述 name 是 String 数据库用户名。 host 是 String 主机地址。 password 是 String 数据库用户密码，非空，至少包含以下字符中的三种：大写字母、小写字母、数字和特殊符号|.~!@#$%^*-_=+?,()&组成，长度8~32个字符。建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 recycle_policy RecyclePolicy object 回收站策略。 表4 RecyclePolicy 参数 参数类型 描述 retention_period_in_days String 保留天数，1-7天。 状态码： 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值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count String 应用记录数量。 histories Array of TemplateApplyHistory objects 应用记录信息 表5 TemplateApplyHistory 参数 参数类型 描述 target_id String 应用实例ID。 target_name String 应用实例名称。 apply_result String 应用结果。 applied_at Number 应用时间。 error_code String 错误码。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "total_count" : 1, "histories" : [ { "target_id" : "06789bdfbe414d78b9cef1b79d7d9680in07", "target_name" : "gauss-11", "apply_result" : "SUC CES S", "applied_at" : 1712246191000, "error_code" : "" } ] }

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

响应示例 状态码： 200 Success. { "total_count" : 4, "enterprise_projects" : [ { "id" : 0, "name" : "default", "description" : null, "status" : 1, "created" : null, "updated" : null }, { "id" : "5c7d11e0-3201-4558-bcce-1172137cf7e2", "name" : "sjw-eps", "description" : null, "status" : 1, "created" : "2023-06-12T02:14:28+0000", "updated" : "2023-06-12T02:14:28+0000" }, { "id" : "12093327-28dc-46c5-8ba6-d42c9236f9d6", "name" : "adf", "description" : null, "status" : 1, "created" : "2023-05-06T08:33:03+0000", "updated" : "2023-05-06T08:33:03+0000" }, { "id" : "07d90b3f-422b-40c9-b9b3-6d00d1d7a60b", "name" : "eps-test", "description" : null, "status" : 1, "created" : "2023-03-16T01:38:13+0000", "updated" : "2023-03-16T01:38:13+0000" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 enterprise_projects Array of EnterpriseProjectItem objects 企业项目信息列表。 total_count Integer 总数。 表5 EnterpriseProjectItem 参数 参数类型 描述 id String 企业项目ID。 name String 企业项目名称。 description String 描述。 status String 状态。 - 1：正常。 - 0：异常。 created String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 updated String 更新时间，格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

响应参数 状态码： 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://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/6b030d160ac24eda9a5320fb38dc2d0ain07/proxy/transaction-split { "transaction_split" : "OFF", "proxy_id_list" : [ "2a2060f2486e4a47934182d91a3b53d2po01" ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 transaction_split 是 String 开启/关闭事务拆分。 取值范围： ON：开启。 OFF：关闭。 proxy_id_list 是 Array of strings 实例的数据库代理列表。

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 open_slow_log_switch Boolean 慢日志开关状态。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应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。

请求示例 数据同步库配置校验。 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" }

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 database_name String 源数据库名称。 db_config_check_results Array of ChDatabaseConfigCheckResult objects 源数据库配置检查结果。 表7 ChDatabaseConfigCheckResult 参数 参数类型 描述 param_name String 库同步配置参数名。 value String 库同步配置参数值。 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. { "database_name" : "blackwhite_0017_22525694", "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" } ] }

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 白名单或黑名单的表范围。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 workflow_id String 工作流ID。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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