Updated on 2025-08-06 GMT+08:00

Updating a SQL Interception Rule

Function

This API is used to update a SQL interception rule to intercept SQL statements that match the rule.

URI

PUT /v1/{project_id}/sql-defend-rules/{rule_id}

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used for resource isolation. For how to obtain a project ID, see Obtaining a Project ID.

rule_id

Yes

String

Unique ID of an interception rule.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

rule_name

Yes

String

Rule name.

Minimum length: 1 character

Maximum length: 32 characters

rule_id

Yes

String

Rule type.

Options:

  • static_0001
  • static_0002
  • static_0003
  • static_0004
  • static_0005
  • static_0006
  • static_0007
  • dynamic_0001
  • dynamic_0002
  • running_0002
  • running_0003
  • running_0004

category

Yes

String

Rule status type.

Options:

  • static
  • dynamic
  • running

engine_rules

Yes

Object

Rule details.

queue_names

No

Array of strings

Queue name.

Response Parameters

Table 3 Response body parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successfully executed. true indicates that the request is successfully executed.

message

String

System prompt. If the execution succeeds, this parameter may be left blank.

Example Request

None

Example Response

None

Status Codes

Status Code

Description

201

The rule is successfully updated.

400

Request error.

500

Internal server error.

Error Codes

If an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see Error Codes.