更新时间:2024-09-11 GMT+08:00

开启或者关闭SQL限流

功能介绍

开启或者关闭SQL限流

URI

POST /v3/{project_id}/instances/{instance_id}/sql-filter/switch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户在某一Region下的project ID。

获取方法请参见获取项目ID

instance_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参数

参数

是否必选

参数类型

描述

switch_status

String

SQL限流开关状态。取值:
  • ON:表示开启。
  • OFF:表示关闭。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

job_id

String

开启或关闭SQL限流任务ID。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

  • 开启SQL限流
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
    {
      "switch_status" : "ON"
    }
  • 关闭SQL限流
    POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instance/af315b8e6aaa41799bd9a31f2de15abcin07/sql-filter/switch
    {
      "switch_status" : "OFF"
    }

响应示例

状态码: 200

Success.

{
  "job_id" : "aef6a470-fb63-4d5b-b644-12ead7e019b3"
}

状态码

请参见状态码

错误码

请参见错误码