华为云用户手册

请求示例 查询TaurusDB实例列表，读写内网IP地址是192.168.0.142。 GET https://{endpoint}/v3/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

URI GET /v3/{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之间是与的关系。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 instances Array of MysqlInstanceListInfo objects 实例列表信息。 total_count Integer 总记录数。 表5 MysqlInstanceListInfo 参数 参数类型 描述 id String 实例ID，严格匹配UUID规则。 name String 创建的实例名称。 status String 实例状态。 取值： BUILD：表示实例正在创建。 ACTIVE：表示实例正常。 FAILED：表示实例创建失败。 FROZEN：表示实例冻结。 MODIFYING：表示实例正在扩容。 REBOOTING：表示实例正在重启。 RESTORING：表示实例正在恢复。 SWITCHOVER：表示实例正在主备切换。 MIGRATING：表示实例正在迁移。 BACKING UP：表示实例正在进行备份。 MODIFYING DATABASE PORT：表示实例正在修改数据库端口。 STORAGE FULL：表示实例磁盘空间满。 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：后付费，即按需付费。 枚举值： prePaid postPaid period_type String 订购周期类型。 取值范围： month：包月。 year：包年。 说明：“charge_mode”为“prePaid”时生效，且为必选值。 枚举值： month year 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 错误消息。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 error_log_list Array of MysqlErrorLogList objects 错误日志具体信息。 total_record Integer 总记录数。 表5 MysqlErrorLogList 参数 参数类型 描述 node_id String 节点ID。 time String 日期时间UTC时间。 level String 日志级别。 content String 错误日志内容。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

响应示例 状态码： 200 Success. { "error_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "time" : "2021-03-06T12:07:05", "level" : "ERROR, content:[MY013508] [Repl] do failed: 1", "total_record" : 15 } ]}

URI GET /mysql/v3/{project_id}/instances/{instance_id}/errorlog 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID 表2 Query参数 参数 是否必选 参数类型 描述 start_date 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100 level 否 String 日志级别 node_id 是 String 节点ID

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 表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 错误描述。

响应示例 状态码： 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 Success. { "schedules" : [ { "job_id" : "56d3c1138dcf4f1da73b0170700c78d0", "instance_id" : "79bc540dd4d6432784894a981fdfacfcin07", "instance_name" : "gauss-f821", "instance_status" : "BUILD", "project_id" : "053f533ead80d5102f0cc012e8d468a4", "job_name" : "VERSION_UPGRADE", "create_time" : "2018-08-06T10:41:14+0000", "start_time" : "2018-08-06T10:41:14+0000", "end_time" : "2018-08-06T10:41:14+0000", "job_status" : "Completed", "datastore_type" : "gaussdb-mysql", "target_config" : { "flavor" : "gaussdb.mysql.xlarge.arm.4", "mem" : "16", "cpu" : "4" } } ], "total_count" : 1}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 schedules Array of ScheduleTask objects 任务详情 total_count Integer 记录总数。 表5 ScheduleTask 参数 参数类型 描述 job_id String 任务ID。 instance_id String 实例ID，严格匹配UUID规则。 instance_name String 实例名称。 instance_status String 实例状态。 取值范围： createfail：表示实例创建失败。 creating：表示实例创建中。 normal：表示实例正常。 abnormal：表示实例异常。 deleted：表示实例已删除。 project_id String 租户在某一Region下的project ID。 job_name String 任务名称。 取值范围有： Create GaussDB forMySQLInstance：表示创建实例。 RestoreGaussDBforMySQLNewInstance：表示恢复新实例。 AddGaussDBforMySQLNodes：表示添加节点。 DeleteGaussDBforMySQLNode：表示删除节点。 RebootGaussDBforMySQLInstance：表示重启实例。 ModifyGaussDBforMySQLPort：表示修改实例端口。 ModifyGaussDBforMySQLSecurityGroup：表示修改实例安全组。 ResizeGaussDBforMySQLFlavor：表示实例规格变更。 SwitchoverGaussDBforMySQLMasterNode：表示只读升主。 GaussDBforMySQLBindEIP：表示绑定弹性公网IP地址。 GaussDBforMySQLUnbindEIP：表示解绑弹性公网IP地址。 RenameGaussDBforMySQLInstance：表示修改实例名称。 DeleteGaussDBforMySQLInstance：表示删除实例集群。 UpgradeGaussDBforMySQLDatabaseVersion：表示版本升级。 EnlargeGaussDBforMySQLProxy：表示实例的数据库代理节点扩容。 OpenGaussDBforMySQLProxy：表示开启实例的数据库代理。 CloseGaussDBforMySQLProxy：表示关闭实例的数据库代理。 GaussdbforMySQLModifyProxyIp：表示修改数据库读写分离地址。 ScaleGaussDBforMySQLProxy：表示实例的数据库代理节点规格变更。 GaussDBforMySQLModifyInstanceMetricExtend：表示实例秒级监控。 GaussDBforMySQLModifyInstanceDataVip：表示修改实例数据浮动IP。 GaussDBforMySQLSwitchSSL：表示切换实例SSL开关。 GaussDBforMySQLModifyProxyConsist：表示修改代理一致性。 GaussDBforMySQLModifyProxyWeight：表示修改代理权重。 create_time String 任务创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 start_time String 任务开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time String 任务结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 job_status String 任务执行状态。 取值范围： Pending：表示延时任务，未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 datastore_type String 数据库类型。 target_config Object 实例配置相关信息，比如规格等。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

URI GET /v3/{project_id}/scheduled-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为1，必须为数字，不能为负数。 limit 否 String 查询记录数。默认为10 status 否 String 任务执行状态。 取值： Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 Pending：表示任务未执行。 start_time 否 String 起始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time 否 String 结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。 其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 job_id 否 String 任务ID。 job_name 否 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参数 参数 是否必选 参数类型 描述 dns_name 是 String 新 域名 的前缀，取值范围如下：8~63个字符之间，可以包含小写字母、数字，不能包含其他特殊字符。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。默认en-us。 取值范围： en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 restore_time 是 Long 备份要恢复的目标时间点。 restore_tables 是 Array of RestoreDatabaseInfo objects 备份要恢复的库表信息。 表4 RestoreDatabaseInfo 参数 是否必选 参数类型 描述 database 是 String 数据库名。 tables 是 Array of RestoreTableInfo objects 数据库表信息。 表5 RestoreTableInfo 参数 是否必选 参数类型 描述 old_name 是 String 原表名。 new_name 是 String 恢复后的表名。

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

请求示例 POST https://{endpoint}/v3.1/619d3e78f61b4be68bc5aa0b59edcf7b/instances/7033e7c3cf93438797d44ad7ae0a7d95in07/restore/tables{ "restore_time" : 1673852043000, "restore_tables" : [ { "database" : "huawei-test", "tables" : [ { "old_name" : "user_table", "new_name" : "new_user_table" } ] } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 node_list 是 Array of SingleNodeInfo objects 节点信息列表 表4 SingleNodeInfo 参数 是否必选 参数类型 描述 node_id 是 String 节点ID。 name 是 String 节点名称。支持中文、数字、字母、连接符-和_，长度为4-128。

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

请求示例 批量修改节点名称。 POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/instances/61a4ea66210545909d74a05c27a7179ein07/nodes/name{ "node_list" : [ { "node_id" : "799a0f2fa49d4151bf2f7063c1fbba36no07", "name" : "gauss-cdf5_node03" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 Content-Type 是 String 内容类型。 取值：application/json。 X-Language 否 String 语言。 表3 请求Body参数 参数 是否必选 参数类型 描述 min_vcpus 是 Integer 单节点VCPUs伸缩下限，取值范围可根据查询数据库规格接口获取。 max_vcpus 是 Integer 单节点VCPUs伸缩上限，取值范围可根据查询数据库规格接口获取。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 tags Array of ResourceTagItem objects 标签列表。 表5 ResourceTagItem 参数 参数类型 描述 key String 标签键。 value 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/{instance_id}/tags 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID，严格匹配UUID规则。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100。

请求参数 表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参数 参数 是否必选 参数类型 描述 password 是 String 数据库密码。取值范围：至少包含以下字符的三种：大写字母、小写字母、数字和特殊符号|.~!@#$%^*-_=+?,()&，长度8~32个字符。建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。如果您输入弱密码，系统会自动判定密码非法。

响应示例 状态码： 200 Success. 示例 1 { "error_log_list" : [ { "node_id" : "cc07c60e94ec4575989840e648fb4f66no07", "count" : 1, "time" : "1.04899 s", "lock_time" : "0.00003 s", "rows_sent" : 0, "rows_examined" : 0, "database" : "gaussdb-mysql", "users" : "root", "query_sample" : "INSERT INTO time_zone_name (Name, Time_zone_id) VALUES (N @time_zone_id);", "type" : "INSERT", "start_time" : "2121-03-25T10:55:16", "client_ip" : "192.*.*.1" } ]} 示例 2 10 示例 3 15

URI GET /mysql/v3/{project_id}/instances/{instance_id}/slowlog 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID。 instance_id 是 String 实例ID 表2 Query参数 参数 是否必选 参数类型 描述 start_date 是 String 开始时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_date 是 String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数 limit 否 Integer 查询记录数。默认为100，不能为负数，最小值为1，最大值为100 type 否 String 语句类型，取空值，表示查询所有语句类型，也可指定如下日志类型：INSERT、UPDATE、SELECT、DELETE和CREATE node_id 是 String 节点ID

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 slow_log_list Array of MysqlSlowLogList objects 错误日志具体信息。 long_query_time String 慢日志阈值。 total_record Integer 总记录数。 表5 MysqlSlowLogList 参数 参数类型 描述 node_id String 节点ID。 count String 执行次数。 time String 执行时间。 lock_time String 等待锁时间。 rows_sent String 结果行数量。 rows_examined String 扫描的行数量。 database String 所属数据库。 users String 账号。 query_sample String 执行语法。 type String 语句类型。 start_time String 发生时间,UTC时间 client_ip String IP地址。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。

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

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

请求参数 表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 最大并发数。取值范围：非负整数。