华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 sql_filter_rules 是 Array of NodeSqlFilterRuleInfo objects 节点级别的SQL限流规则。 表4 NodeSqlFilterRuleInfo 参数 是否必选 参数类型 描述 node_id 是 String 节点ID。 rules 是 Array of NodeSqlFilterRule objects SQL限流规则。集合的sql_type值不能重复。 表5 NodeSqlFilterRule 参数 是否必选 参数类型 描述 sql_type 是 String Sql限流类型。 取值范围： SELECT UPDATE DELETE patterns 是 Array of NodeSqlFilterRulePattern objects SQL限流具体规则。 表6 NodeSqlFilterRulePattern 参数 是否必选 参数类型 描述 pattern 是 String SQL限流规则，由一个或多个关键字（最多为128个关键字）组成，关键字之间通过"~"分隔符分开，如select~from~t1。规则中不能包含‘\’、中英文逗号、‘~~’，不能以‘~’结尾。 max_concurrency 是 Integer 最大并发数。取值范围：非负整数。

URI PUT /v3/{project_id}/instances/{starrocks_instance_id}/starrocks/restart 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 starrocks_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

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

请求示例 开启新增节点自动加入该Proxy。 POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/e73893ef73754465a8bd2e0857bbf13ein07/proxy/e87088f0b6a345e79db19d57c41fde15po01/new-node-auto-add { "switch_status" : "ON", "weight" : 100 }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 开启或关闭新增节点自动加入该Proxy的操作结果。 状态码： 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参数 参数 是否必选 参数类型 描述 switch_status 是 String 是否开启新增节点自动加入该Proxy。 取值范围： ON：开启。 OFF：关闭。 weight 否 Integer 新增节点的读权重： 新增节点自动加入为ON，取值为0~1000。 新增节点自动加入为OFF，则可不输入读权重。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 charsets Array of strings 数据库字符集列表 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表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 记录总数。 records Array of AutoScalingRecordInfo objects 自动变配历史记录列表。 表5 AutoScalingRecordInfo 参数 参数类型 描述 id String 记录ID。 instance_id String 实例ID。 instance_name String 实例名称。 scaling_type String 变配类型。 original_value String 原始值。 target_value String 目标值。 result String 变配结果。 create_at String 变配时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "total_count" : 1, "records" : [ { "id" : "2f5f3eeb-16c7-4b0c-bd44-4b2968275abe", "instance_id" : "94bb6ce031424d02a1c61019d1d2298bin07", "instance_name" : "gaussdbformysql-ins01", "scaling_type" : "ENLARGE_FLAVOR", "original_value" : "gaussdb.mysql.medium.x86.4", "target_value" : "gaussdb.mysql.large.x86.4", "result" : "SUC CES SFUL", "create_at" : "2023-04-30 16:47:40.877" } ] }

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

响应示例 状态码： 201 Success. { "instance" : { "id" : "590031445ef845bb912d7fc8243db80cin17", "az_code" : "cn-southwest-244b", "az_mode" : "single", "name" : "htap-ff64", "engine" : { "type" : "star-rocks", "version" : "3.1" }, "vpc_id" : "d5a1a29b-1476-490f-9682-c1a59593e7b0", "security_group_id" : "967a0ac2-3cae-4e57-a49a-d0f6ff07dcc1", "sub_net_id" : "2ce0bc80-bfc5-4d5e-9b78-a7f91572e03b", "db_user" : "root", "port" : 3306, "ha_mode" : "Single", "pay_info" : { "pay_model" : "0", "order_id" : null, "period" : null, "period_type" : null, "is_auto_renew" : null }, "enable_ssl" : false, "status" : "creating", "region" : "cn-southwest-244", "tags_info" : { "tags" : [ ], "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "0" } ] } }, "job_id" : "cf0b7506-1505-450f-9d95-ce9d93b6b5c3" }

请求示例 创建数据库实例 POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/40dc4c5729f14aad893e2dcd5baf6a15in07/starrocks { "name" : "htap-ff64", "engine" : { "type" : "star-rocks", "version" : "3.1" }, "ha" : { "mode" : "Single" }, "fe_flavor_id" : "afef3bfd-ac7c-32e1-ba44-c388acbb196a", "be_flavor_id" : "de565db8-0a96-37ea-9388-61167624712c", "db_root_pwd" : "Test@123!", "fe_count" : 1, "be_count" : 1, "az_mode" : "single", "fe_volume" : { "io_type" : "SSD", "capacity_in_gb" : 50 }, "be_volume" : { "io_type" : "SSD", "capacity_in_gb" : 50 }, "az_code" : "cn-southwest-244b", "time_zone" : "UTC+08:00", "tags_info" : { "sys_tags" : [ { "key" : "_sys_enterprise_project_id", "value" : "0" } ] } }

响应参数 状态码： 201 表11 响应Body参数 参数 参数类型 描述 instance instance object 实例信息。 job_id String 工作流ID。 表12 instance 参数 参数类型 描述 id String StarRocks实例ID，严格匹配UUID规则。 az_code String 可用区码。 az_mode String 可用区模式。 取值范围： single：单可用区。 multi：多可用区。 name String 实例名称。 engine engine object 引擎信息。 vpc_id String 虚拟私有云ID。 security_group_id String 安全组ID。 sub_net_id String 子网ID。 db_user String 数据库用户。默认root。 port Integer 数据库端口号。默认3306。 ha_mode String 部署模式。 pay_info pay_info object 计费信息。 enable_ssl Boolean SSL开关。 status String 实例状态。 region String 实例所在区域。 tags_info tags_info object 实例标签。 表13 engine 参数 参数类型 描述 type String 引擎类型。 version String 引擎大版本号。 表14 pay_info 参数 参数类型 描述 pay_model String 计费模式。 0：按需计费 1：包周期 StarRocks实例当前只支持按需计费，默认值为0 order_id String 包周期计费ID。 period String 包周期周期。 period_type String 包周期周期类型。 is_auto_renew String 包周期是否自动续费。 表15 tags_info 参数 参数类型 描述 tags Array of tags objects 用户标签。默认为空。 sys_tags Array of sys_tags objects 系统标签。 表16 tags 参数 参数类型 描述 key String 标签键。 value String 标签值。 表17 sys_tags 参数 参数类型 描述 key String 标签键。 value String 标签值。 状态码： 400 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表19 响应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 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 实例名称。同一租户下，同类型的实例名可重名。 取值范围：最小为4个字符，最大为64个字符且不超过64个字节，必须以字母开头，区分大小写，可以包含字母、数字、中划线、下划线，不能包含其他特殊字符。不支持中文名。 engine 是 engine object 引擎信息。 ha 是 ha object 部署信息。 fe_flavor_id 是 String FE节点规格ID。使用可通过查询HTAP规格响应消息中的“id”。 be_flavor_id 是 String BE节点规格ID。使用可通过查询HTAP规格响应消息中的“id”。 db_root_pwd 是 String 数据库密码。 取值范围：至少包含以下字符的三种：大小写字母、数字和特殊符号~!@#$%^*-_=+?,()&|.，长度8~32个字符。 建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。 fe_count 是 Integer FE节点数。 单机时固定为1 集群时取值[3, 10] be_count 是 Integer BE节点数。 单机时固定为1 集群时取值[3, 10] az_mode 是 String 可用区类型。 当前仅支持single。 fe_volume 是 fe_volume object FE节点存储规格。 be_volume 是 be_volume object BE节点存储规格。 az_code 是 String 可用区代码。 time_zone 否 String 时区。默认时区为UTC+08:00。 tags_info 是 tags_info object 标签信息。 security_group_id 否 String 实例安全组ID。默认与Taurus安全组ID一致。 pay_info 否 pay_info object 支付信息。包周期场景必填。 region_code 否 String 可用区。包周期场景必填。 表4 engine 参数 是否必选 参数类型 描述 type 是 String 引擎类型。仅支持star-rocks。 version 是 String 引擎大版本号。 表5 ha 参数 是否必选 参数类型 描述 mode 是 String 部署模式。 表6 fe_volume 参数 是否必选 参数类型 描述 io_type 是 String 磁盘类型。通过查询HTAP引擎资源返回消息获取。 capacity_in_gb 是 Integer 磁盘容量，单位GB 增长的步长：10GB。 表7 be_volume 参数 是否必选 参数类型 描述 io_type 是 String 磁盘类型。通过查询HTAP引擎资源返回消息获取。 capacity_in_gb 是 Integer 磁盘容量，单位GB 增长的步长：10GB。 表8 tags_info 参数 是否必选 参数类型 描述 sys_tags 是 Array of sys_tags objects 系统标签。 表9 sys_tags 参数 是否必选 参数类型 描述 key 是 String 标签键。 value 是 String 标签值。 表10 pay_info 参数 是否必选 参数类型 描述 pay_model 否 String 计费模式，默认0。包周期场景必填。 取值范围： 0：按需计费 1：包周期 period 否 String 包周期周期。包周期场景必填。 period_type 否 String 包周期周期类型。包周期场景必填。 取值范围： 2：包月 3：包年 is_auto_renew 否 String 包周期是否自动续费。包周期场景必填。 取值范围： 1：自动续费 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参数 参数 是否必选 参数类型 描述 alias 是 String 实例备注。 长度可在0~64个字符之间，由字母、数字、汉字、英文句号、下划线、中划线组成。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总数。 histories Array of ParamGroupHistoryResponse objects 参数模板的修改历史列表。 表5 ParamGroupHistoryResponse 参数 参数类型 描述 parameter_name String 参数名称。 old_value String 修改前参数值。 new_value String 修改后参数值。 update_result String 更新结果。 is_applied Boolean 是否应用。 true：是。 false：否。 updated String 修改时间。格式为“yyyy-mm-ddThh:mm:ssZ”。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 applied 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 错误消息。

响应示例 状态码： 200 Success. { "total_count" : 2, "histories" : [ { "parameter_name" : "binlog_rows_query_log_events", "old_value" : "OFF", "new_value" : "ON", "update_result" : "SUCCESS", "is_applied" : true, "updated" : "2023-07-10T02:14:28+0000", "applied" : "2023-07-10T02:14:28+0000" }, { "parameter_name" : "block_encryption_mode", "old_value" : "aes-256-cbc", "new_value" : "aes-128-cfb1", "update_result" : "SUCCESS", "is_applied" : true, "updated" : "2023-07-10T02:14:28+0000", "applied" : "2023-07-10T02:14:28+0000" } ] }

URI GET /v3/{project_id}/configurations/{configuration_id}/modify-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 configuration_id 是 String 参数组ID。 通过调用查询实例详情信息接口获取。 请求响应成功后在响应消息体中包含的“configuration_id”的值即为configuration_id值。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 专属资源池ID。 resource_name String 专属资源池名称。 engine_name String 数据库引擎名称。 availability_zone_ids Array of strings 可用区。 architecture String 资源规格类型。 status String 专属资源池状态。 dedicated_compute_info DedicatedComputeInfo object 计算资源信息。 dedicated_storage_info DedicatedStorageInfo object 存储资源信息。 表4 DedicatedComputeInfo 参数 参数类型 描述 vcpus_total Integer 专属资源池中CPU总数。 vcpus_used Integer 专属资源池已使用的CPU数。 ram_total Integer 专属资源池计算内存大小, 单位GB。 ram_used Integer 专属资源池已使用的计算内存大小，单位GB。 spec_code String 专属资源池计算资源规格码。 host_num Integer 专属资源池计算主机数量。 表5 DedicatedStorageInfo 参数 参数类型 描述 spec_code String 专属资源池存储资源规格码。 host_num Integer 专属资源池存储主机数量。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/dedicated-resource/{dedicated_resource_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 dedicated_resource_id 是 String 专属资源池ID。 获取方法参见查询专属资源信息详情。

响应示例 状态码： 200 Success. { "id" : "e289fda5-a065-4324-8751-cff68be6f48e", "resource_name" : "test_dcc", "engine_name" : "gaussdb-mysql", "availability_zone_ids" : [ "az1xahz", "az2xahz" ], "architecture" : "ARM", "status" : "normal", "dedicated_compute_info" : { "vcpus_total" : 128, "vcpus_used" : 64, "ram_total" : 512, "ram_used" : 256, "spec_code" : "gaussdb.mysql.c6.host", "host_num" : 1 }, "dedicated_storage_info" : { "spec_code" : "gaussdb.mysql.dfvpool.30tb.host", "host_num" : 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参数 参数 是否必选 参数类型 描述 user_name 是 String 数据库账户名。长度为2-32个字符，必须以小写字母开头，小写字母或数字结尾，可以包含小写字母、数字以及下划线，不能包含其它特殊字符。 password 是 String 账户密码。 8-32个字符 至少包含以下字符中的三种：大写字母、小写字母、数字和特殊字符~！@#%^*-_=+? 不能与用户名或倒序的用户名相同 databases 是 Array of strings 数据库列表。“*”表示所有数据库。 dml 否 Integer DML权限，默认2。 取值范围： 1：只读权限 2：读取和设置权限

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 请求结果。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

请求示例 创建数据库账号。 POST https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/df3ae779e2ad4993a03ccd7a81240125in16/clickhouse/users { "user_name" : "user_test1", "password" : "Rds_1234", "databases" : [ "*" ], "dml" : 1 }

请求示例 创建ClickHouse数据同步。 POST https://{localhost}/v3/23a50154cf494ec9ad6883979a12db0a/instances/54e42160670e48e789af7075e1efea1fin16/clickhouse/replication { "source_instance_id" : "source_instance_id", "source_node_id" : "source_node_id", "source_database" : "source_database" }

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 source_instance_id 是 String 源实例ID。 source_node_id 否 String 源节点ID。TaurusDB只读节点ID。如为空，则取TaurusDB主节点ID。 source_database 是 String 源数据库。