华为云用户手册

请求示例 POST https://{localhost}/v3/{project_id}/instances/{instance_id}/starrocks/databases/replication { "source_instance_id" : "source_instance_id", "source_node_id" : "source_node_id", "source_database" : "source_database", "target_database" : "target_database", "task_name" : "task_name" }

URI POST /v3/{project_id}/instances/{instance_id}/starrocks/databases/replication 表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值。 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 是 String 源数据库。字符长度限制3~1024位，仅支持英文大小写字母、数字以及下划线。 target_database 是 String 目标数据库。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。 task_name 是 String 同步任务名。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

响应参数 状态码： 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. { "databases" : [ "INFORMATION_SCHEMA", "connections_db1_08759", "connections_db1_31465", "default", "information_schema", "system" ], "total_count" : 6, "timestamp" : 1706257484 } 状态码： 400 Client error. { "error_code" : "DBS.200022", "error_msg" : "实例不存在" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 databases Array of strings 数据库名称。 total_count Integer 数据库数量。 timestamp Integer 查询时间戳。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

URI GET /v3/{project_id}/instances/{instance_id}/starrocks/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String StarRocks实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 查询记录数。 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 database_name 否 String 查询的数据库名称，支持模糊搜索。字符长度限制3~128位，仅支持英文大小写字母、数字以及下划线。

响应示例 状态码： 200 Success. { "total_count" : 1, "instances" : [ { "id" : "61a4ea66210545909d74a05c27a7179ein07", "name" : "gaussdb-mysql-instance01", "status" : "normal", "port" : 3306, "type" : "Cluster", "private_ips" : [ "192.168.0.142" ], "readonly_private_ips" : [ "192.168.0.228", "192.168.0.165" ], "proxy_ips" : [ "192.168.0.15" ], "db_user_name" : "root", "region" : "cn-north-4", "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0", "kernel_version" : "2.0.29.1" }, "created" : "2018-08-20T02:33:49_0800", "updated" : "2018-08-20T02:33:49_0800", "volume" : { "type" : "POOL", "size" : 100 }, "vpc_id" : "3cedfc54-b105-4652-a4e0-847b11576b58", "subnet_id" : "c1cfa53c-65d3-431e-8552-326bf310c7ad", "security_group_id" : "fc577a1a-f202-424a-977f-24faec3fdd55", "flavor_ref" : "gaussdb.mysql.c3.small.4", "flavor_info" : { "vcpus" : 8, "ram" : 16 }, "backup_strategy" : { "start_time" : "19:00-20:00", "keep_days" : 7 }, "charge_info" : { "charge_mode" : "postPaid" }, "enterprise_project_id" : 0, "time_zone" : "UTC", "tags" : [ { "key" : "taurusKey1", "value" : "value1" } ] } ] }

请求示例 查询TaurusDB实例列表，读写内网IP地址是192.168.0.142。 GET https://{endpoint}/v3.1/054e292c9880d4992f02c0196d3ea468/instances?id=61a4ea66210545909d74a05c27a7179ein07&name=gaussdb-mysql-instance01&type=Cluster&datastore_type=gaussdb-mysql&vpc_id=3cedfc54-b105-4652-a4e0-847b11576b58&subnet_id=c1cfa53c-65d3-431e-8552-326bf310c7ad&private_ip=192.168.0.142&offset=0&limit=10&tags=taurusKey1=value1

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceListInfoUnifyStatus objects 实例列表信息。 total_count Integer 总记录数。 表5 MysqlInstanceListInfoUnifyStatus 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 创建的实例名称。 status String 实例状态。 取值： 值为“creating”，表示实例正在创建。 值为“normal”，表示实例正常。 值为“abnormal”，表示实例异常。 值为“createfail”，表示实例创建失败。 private_ips Array of strings 实例写内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空字列表。 proxy_ips Array of strings 实例读写分离IP地址列表。TaurusDB实例开启代理成功后该值存在，其他情况下为空列表。 readonly_private_ips Array of strings 实例读内网IP地址列表。弹性云服务器创建成功后该值存在，其他情况下为空列表。 public_ips Array of strings 实例外网IP地址列表。 port String 数据库端口号。 type String 实例类型，取值为“Cluster”。 region String 实例所在区域。 datastore MysqlDatastoreWithKernelVersion object 数据库信息。 created String 创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 updated String 更新时间，格式与"created"字段对应格式完全相同。 db_user_name String 默认用户名。 vpc_id String 虚拟私有云ID。 subnet_id String 子网的网络ID信息。 security_group_id String 安全组ID。 flavor_ref String 规格码。 flavor_info MysqlFlavorInfo object flavor规格信息。 volume MysqlVolumeInfo object 存储盘信息。 backup_strategy MysqlBackupStrategy object 自动备份策略。 enterprise_project_id String 企业项目ID。 time_zone String 时区。 charge_info MysqlChargeInfo object 计费类型信息，支持包年包月和按需，默认为按需。 dedicated_resource_id String 专属资源池ID，只有数据库实例属于专属资源池才会返回该参数。 tags Array of InstanceTagItem objects 标签列表。 表6 MysqlDatastoreWithKernelVersion 参数 参数类型 描述 type String 数据库引擎，现在只支持gaussdb-mysql。 version String 数据库版本。 kernel_version String 数据库内核版本。 表7 MysqlFlavorInfo 参数 参数类型 描述 vcpus String CPU核数。 ram String 内存大小，单位GB。 表8 MysqlVolumeInfo 参数 参数类型 描述 type String 磁盘类型。 size String 已使用磁盘大小，单位GB。 表9 MysqlBackupStrategy 参数 参数类型 描述 start_time String 自动备份开始时间段。自动备份将在该时间一个小时内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00。 keep_days String 自动备份保留天数，取值范围：1-732。 表10 MysqlChargeInfo 参数 参数类型 描述 charge_mode String 计费模式。 取值范围： prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 period_type String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 period_num Integer “charge_mode”为“prePaid”时生效，且为必选值，指定订购的时间。 取值范围： “period_type”为“month”时，取值为1~9。 “period_type”为“year”时，取值为1~3。 is_auto_renew String 创建包年/包月实例时可指定，表示是否自动续订，续订的周期和原周期相同，且续订时会自动支付。 true：为自动续订。 false：为不自动续订，默认该方式。 is_auto_pay String 创建包年/包月实例时可指定，表示是否自动从客户的账户中支付，此字段不影响自动续订的支付方式。 true：为自动支付，默认该方式。 false：为手动支付。 表11 InstanceTagItem 参数 参数类型 描述 key String 标签键。 value String 标签值。 状态码： 400 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3.1/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 实例ID。“*”为系统保留字符，如果id是以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照id精确匹配查询。不能只传入“*”。 name 否 String 实例名称。 “*”为系统保留字符，如果name是以“*”起始，表示按照“*”后面的值模糊匹配，否则，按照name精确匹配查询。不能只传入“*”。 type 否 String 按照实例类型查询。目前仅支持Cluster。 datastore_type 否 String 数据库类型，现在只支持gaussdb-mysql。 vpc_id 否 String 虚拟私有云ID。 subnet_id 否 String 子网的网络ID信息。 private_ip 否 String 读写内网IP地址。 readonly_private_ip 否 String 读内网IP地址。 proxy_ip 否 String 读写分离IP地址。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。 tags 否 String 根据实例标签键值对进行查询。 {key}表示标签键。 {value}表示标签值。 如果同时使用多个标签键值对进行查询，中间使用逗号分隔开，表示查询同时包含指定标签键值对的实例。key不能重复，key之间是与的关系。

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

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

URI GET /v3/{project_id}/instances/{instance_id}/sql-filter/rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 node_id 是 String 节点ID。 sql_type 否 String SQL限流类型，取值为SELECT、UPDATE、DELETE，不区分大小写；若不传则默认查询所有类型的限流规则。

响应示例 状态码： 200 Success. { "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", "sql_filter_rules" : [ { "sql_type" : "SELECT", "patterns" : [ { "pattern" : "select~from~t1", "max_concurrency" : 0 }, { "pattern" : "select~from~t2~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "UDPATE", "patterns" : [ { "pattern" : "update~t1", "max_concurrency" : 0 }, { "pattern" : "update~t2~where~id", "max_concurrency" : 10 } ] }, { "sql_type" : "DELETE", "patterns" : [ { "pattern" : "delete~from", "max_concurrency" : 0 } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 node_id String 节点ID。 sql_filter_rules Array of SqlFilterRule objects SQL限流规则。 表5 SqlFilterRule 参数 参数类型 描述 sql_type String SQL限流类型。 取值范围： SELECT UPDATE DELETE patterns Array of SqlFilterRulePattern objects SQL限流具体规则。 表6 SqlFilterRulePattern 参数 参数类型 描述 pattern String SQL限流规则。 max_concurrency Integer 最大并发数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 status String 状态信息。 instance_id String 实例ID，严格匹配UUID规则。 instance_name 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。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_policy 是 MysqlBackupPolicy object 数据库备份策略信息。 表4 MysqlBackupPolicy 参数 是否必选 参数类型 描述 start_time 是 String 备份时间段。自动备份将在该时间段内触发。 取值范围：非空，格式必须为hh:mm-HH:MM且有效，当前时间指UTC时间。HH取值必须比hh大1。mm和MM取值必须相同，且取值必须为00。 取值示例：21:00-22:00 keep_days 是 Integer 备份文件的保留天数。取值范围：1~732。您也可以联系客服申请开通最大保留天数为3660。 period 是 String 备份周期配置。自动备份将在每星期指定的天进行。 取值范围：格式为逗号隔开的数字，数字加1表示自动备份的星期。 取值示例：1,2,3,4,5,6,7则表示备份周期配置为星期二、星期三、星期四、星期五、星期六、星期日、星期一。 retention_num_backup_level1 否 Integer 一级备份保留数量，取值：0或1，默认值为0。当一级备份开关开启时，该参数必传。反之，不能传。

请求示例 修改实例的自动备份策略，每周的周二至周六的19:00-20:00进行备份，备份文件保留7天。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/21b6ea5a78244de98c1c2622e1dc593ain07/backups/policy/update { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,3,4,5" } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 quotas project-quotas object 租户实例配额信息。 表5 project-quotas 参数 参数类型 描述 resources Array of resource objects 资源列表对象。 表6 resource 参数 参数类型 描述 mode String 资源类型。 cluster: 表示集群版实例的配额 枚举值： cluster type String 指定类型的配额。 instance: 表示实例的配额 枚举值： instance used Integer 已创建的资源个数。 quota Integer 资源最大的配额数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /mysql/v3/{project_id}/project-quotas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 根据type过滤查询指定类型的配额。 取值范围：instance 枚举值：instance

响应参数 状态码： 201 表6 响应Body参数 参数 参数类型 描述 job_id String 参数解释: 创建数据库用户的任务ID。 取值范围： 符合UUID规则。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 创建数据库用户，读写权限，主机IP地址是127.0.0.1。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/a23fb62bd61e4e9e9636fd2225f395bein07/db-users { "users" : [ { "name" : "gaussdb_mysql_user1", "password" : "***", "hosts" : [ "127.0.0.1" ], "comment" : "database_user_comment", "databases" : [ { "name" : "test", "readonly" : false } ] } ] }

URI POST /v3/{project_id}/instances/{instance_id}/db-users 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 instance_id 是 String 参数解释： 实例ID，此参数是实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 默认取值： 不涉及。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 password 是 String 数据库密码。 取值范围：至少包含以下字符的三种：大小写字母、数字和特殊符号|.~!@#$%^*-_=+?,()&，长度8~32个字符。建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 node_list Array of node_list objects ClickHouse实例节点列表。 表4 node_list 参数 参数类型 描述 node_id String ClickHouse实例节点id。 node_name String ClickHouse实例节点名称。 role String 节点主备角色。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

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

URI PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/port 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 proxy_id 是 String 数据库代理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参数 参数 是否必选 参数类型 描述 port 是 Integer 修改后的读写分离端口。 TaurusDB Proxy端口号范围：大于等于1025，小于等于65534，不包含端口1033、5342-5345、12017、20000、20201、20202、33062、33071。

请求示例 升级数据库代理实例内核版本。 POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/517ea793ab91438cbfcd9c4b1c958b1ein07/proxy/0f46fc46396e4fb19a0cb52f578e9511po01/upgrade-version { "source_version" : "2.23.12.000", "target_version" : "2.24.03.000" }