Help Center/ Data Lake Insight/ API Reference/ SQL Job Interception Rules/ Querying a SQL Interception Rule
Updated on 2026-01-08 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a SQL Interception Rule

Function

This API is used to query a single SQL interception rule.

Authorization

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see the required permissions in Introduction.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependency

    dli:sqldefendrule:get

    Read

    -

    -

    -

    -

URI

GET /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

None

Response Parameters

Table 2 Response body parameters

Parameter

Type

Description

rule_uuid

String

Unique ID of a rule.

Maximum length: 64 characters

project_id

String

Project ID.

Maximum length: 64 characters

rule_name

String

Rule name.

Minimum length: 1 character

Maximum length: 32 characters

rule_id

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

String

Rule status type.

Options:

  • static
  • dynamic
  • running

engine_rules

Object

Rule details.

queue_names

Array of strings

Queue name.

desc

String

Rule description.

Maximum length: 2,000 characters

sys_desc

String

System rule description.

create_time

Long

Time when a rule was created.

update_time

Long

Time when a rule was updated.

Example Request

None

Example Response

None

Status Codes

Status Code

Description

201

A rule is successfully queried.

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.