华为云用户手册

响应参数 状态码： 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" }

请求参数 表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。

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

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

请求示例 修改数据库账户权限。 PUT https://{endpoint}/v3/23a50154cf494ec9ad6883979a12db0a/instances/86fd60a5256a4592b957e8e6bb2d1b59in07/starrocks/users/permission { "user_name" : "user_test", "dml" : 2, "databases" : [ "*" ] }

请求参数 表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 数据库账号名。 databases 否 Array of strings 数据库列表。 dml 否 Integer DML权限。 取值范围： 0：读写权限 1：只读权限 2：只读和设置权限 3：读写和设置权限 ddl 否 Integer DDL权限。 取值范围： 0：无DDL权限 1：有DDL权限

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

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 job_id String 删除SQL限流规则任务ID。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 删除SQL限流规则，限流类型为SELECT、UPDATE、DELETE。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/rules { "sql_filter_rules" : [ { "node_id" : "c01a5645eb2c4fb6a9373542f5366e50no07", "rules" : [ { "sql_type" : "SELECT", "patterns" : [ "select~from~t1", "select~from~t2" ] }, { "sql_type" : "UPDATE", "patterns" : [ "udpate~t3~where~id" ] } ] }, { "node_id" : "b234a5645eb2c4ji3b9372342f5362397no07", "rules" : [ { "sql_type" : "SELECT", "patterns" : [ "select~from~t1", "select~from~t2" ] }, { "sql_type" : "DELETE", "patterns" : [ "delete~t3~where~id" ] } ] } ] }

请求参数 表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 DeleteNodeSqlFilterRuleInfo objects 节点级别的SQL限流规则。 表4 DeleteNodeSqlFilterRuleInfo 参数 是否必选 参数类型 描述 node_id 是 String 节点ID rules 是 Array of DeleteNodeSqlFilterRule objects SQL限流规则。 表5 DeleteNodeSqlFilterRule 参数 是否必选 参数类型 描述 sql_type 是 String Sql限流类型。 取值范围： SELECT UPDATE DELETE patterns 是 Array of strings SQL限流具体规则。

响应示例 状态码： 200 Success. { "backups" : [ { "id" : "7420f28010084e838113e78f77093093br07", "name" : " GaussDB forMySQL-gauss-e747-20200708185048266", "begin_time" : "2020-07-08T20:43:14+0800", "end_time" : "2020-07-08T20:45:14+0800", "take_up_time" : 2, "status" : "COMPLETED", "type" : "auto", "size" : 2803, "datastore" : { "type" : "gaussdb-mysql", "version" : "8.0" }, "instance_id" : "3ef58db3986540d19f95151309368d34in07", "instance_name" : "GaussDBforMySQL-gauss-e747", "backup_level" : "2" } ], "total_count" : 1 }

请求示例 查询指定实例指定备份在时间段内（2020-07-06~2020-07-16）的自动备份列表。 GET https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/backups?instance_id=3ef58db3986540d19f95151309368d34in07&backup_id=7420f28010084e838113e78f77093093br07&backup_type=auto&offset=0&limit=10&begin_time=2020-07-06T10:41:14+0800&end_time=2020-07-16T10:41:14+0800

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backups Array of backups objects 参数解释： 备份信息。 取值范围： 不涉及。 total_count Long 参数解释： 备份文件的总数。 取值范围： ≥0。 表5 backups 参数 参数类型 描述 id String 参数解释： 备份ID。 取值范围： 只能由英文字母、数字组成，后缀为br07，长度为36个字符。 name String 参数解释： 备份名称。 取值范围： 备份名称长度最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中文、中划线或下划线，不能包含其他特殊字符。 begin_time String 参数解释： 备份开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 end_time String 参数解释： 备份结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 取值范围： 不涉及。 status String 参数解释 ： 备份状态。 取值范围： BUILDING：备份中。 COMPLETED：备份完成。 FAILED：备份失败。 AVAILABLE：备份可用。 take_up_time Integer 参数解释 ： 备份花费时间（单位：minutes）。 取值范围： ≥0。 type String 参数解释 ： 备份类型。 取值范围： auto：自动全量备份。 manual：手动全量备份。 size Long 参数解释 ： 备份大小（单位：MB）。 取值范围： ＞0。 datastore MysqlDatastoreInBackup object 参数解释： 数据库信息。 instance_id String 参数解释： 实例ID，此参数是实例的唯一标识。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 instance_name String 参数解释： 实例名称。 取值范围： 最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 backup_level String 参数解释： 备份级别。当开启一级备份开关时，返回该参数。 取值范围： 0：备份正在创建中或者备份失败。 1：一级备份。 2：二级备份。 description String 参数解释： 备份文件描述信息。 取值范围： 不涉及。 表6 MysqlDatastoreInBackup 参数 参数类型 描述 type String 参数解释： 数据库引擎。 取值范围： gaussdb-mysql。 version String 参数解释： 数据库版本。 取值范围： 8.0。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 约束限制： 不涉及。 取值范围： 不涉及。 默认值： 不涉及。 X-Language 否 String 参数解释： 请求语言类型。 约束限制： 不涉及。 取值范围： en-us zh-cn 默认值： en-us。

URI GET /v3/{project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，且长度为32个字符。 默认值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 instance_id 否 String 参数解释： 实例ID，此参数是实例的唯一标识。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为in07，长度为36个字符。 默认取值： 不涉及。 backup_id 否 String 参数解释： 备份ID，此参数是备份的唯一标识。。 约束限制： 不涉及。 取值范围： 只能由英文字母、数字组成，后缀为br07，长度为36个字符。 默认取值： 不涉及。 backup_type 否 String 参数解释： 备份类型。 约束限制： 不涉及。 取值范围： auto：自动全量备份。 manual：手动全量备份。 默认值： 不涉及。 offset 否 String 参数解释： 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。 约束限制： 必须为整数，不能为负数。 取值范围： ≥0 默认取值： 0 limit 否 String 参数解释： 查询记录数。 约束限制： 必须为整数，不能为负数。 取值范围： 1-100 默认取值： 100 begin_time 否 String 参数解释： 查询开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 约束限制： 不涉及。 取值范围： 比当前时间早。 默认取值： 不涉及。 end_time 否 String 参数解释： 查询结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 约束限制： 不涉及。 取值范围： 比当前时间早，比开始时间晚。 默认取值： 不涉及。 name 否 String 参数解释： 备份名称。 约束限制： 不涉及。 取值范围： 备份名称长度最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中文、中划线或下划线，不能包含其他特殊字符。 默认取值： 不涉及。 instance_name 否 String 参数解释： 实例名称。 约束限制： 不涉及。 取值范围： 最小为4个字符，最大为64个字符且不超过64个字节（注意：一个中文字符占用3个字节），必须以字母或中文开头，区分大小写，可以包含字母、数字、中划线、下划线或中文，不能包含其他特殊字符。 默认取值： 不涉及。

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

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

请求示例 开启数据库代理的会话连接池。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/5881e1ca66af4aefbc64dc2874e55b3fpo01/connection-pool-type { "connection_pool_type" : "SESSION" } 关闭数据库代理的连接池。 PUT https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/proxy/5881e1ca66af4aefbc64dc2874e55b3fpo01/connection-pool-type { "connection_pool_type" : "CLOSED" }

URI PUT /v3/{project_id}/instances/{instance_id}/proxy/{proxy_id}/connection-pool-type 表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参数 参数 是否必选 参数类型 描述 connection_pool_type 是 String 连接池类型。 取值范围： CLOSED：关闭连接池。 SESSION：开启会话级连接池。

URI GET /v3/{project_id}/instances/{instance_id}/restore-time 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 date 否 String 所需查询的日期，为yyyy-mm-dd字符串格式，时区为UTC。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 restore_times Array of RestoreTimeInfo objects 可恢复时间段列表。 表5 RestoreTimeInfo 参数 参数类型 描述 start_time Long 可恢复时间段的起始时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 end_time Long 可恢复时间段的结束时间点，UNIX时间戳格式，单位是毫秒，时区是UTC。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 表级时间点恢复。 POST https://{endpoint}/v3/97b026aa9cc4417888c14c84a1ad9860/instances/61a4ea66210545909d74a05c27a7179ein07/backups/restore/tables { "restore_time" : 1690890940000, "last_table_info" : true, "restore_tables" : [ { "database" : "test_db_1", "tables" : [ { "new_name" : "t3_1690899914000", "old_name" : "t3" } ] } ] }

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

URI POST /v3/{project_id}/instances/{instance_id}/backups/restore/tables 表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 zh-cn 默认值： en-us。 表3 请求Body参数 参数 是否必选 参数类型 描述 restore_time 是 String 参数解释： 备份时间点。 约束限制： 格式为UNIX时间戳，单位是毫秒，时区为UTC标准时区。传参时需要将对应时区的时间转为标准时区对应的时间戳，比如，北京时区的时间点需要-8h后再转为时间戳。 取值范围： 通过查询可恢复时间段获取。 默认取值： 不涉及。 restore_tables 是 Array of CreateRestoreDatabaseTableInfo objects 数据库信息。 last_table_info 否 String 参数解释： 是否是最新库表。 约束限制： 不涉及。 取值范围： true：是最新库表。 false：是恢复时间点库表。 默认取值： false。 表4 CreateRestoreDatabaseTableInfo 参数 是否必选 参数类型 描述 database 是 String 参数解释： 数据库名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： false。 tables 是 Array of CreateRestoreTableInfo objects 表信息。 表5 CreateRestoreTableInfo 参数 是否必选 参数类型 描述 old_name 是 String 参数解释： 恢复前表名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： false。 new_name 是 String 参数解释： 恢复后表名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： false

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 job_id String 任务ID。 order_id String 订单号，仅包年/包月返回该参数。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

请求示例 退订指定的包年/包月实例。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/096c0fc43e804757b59946b80dc27f8bin07 删除指定按需实例。 DELETE https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/7f5bed98332e493a8a2d213c233ff556in07