Updated on 2022-12-29 GMT+08:00

Querying Sensitive Data Scanning Rule Groups

Function

This API is used to query the sensitive data scanning rule groups based on a specified project ID.

URI

GET /v1/{project_id}/sdg/server/scan/groups

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Page number

limit

No

Integer

Page limit

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Integer

Total number of rule groups

groups

Array of ResponseGroup objects

Rule group list

Table 4 ResponseGroup

Parameter

Type

Description

category

String

Rule type, which can be built-in rule (BUILT_IN) or self-built rule (BUILT_SELF).

Enumeration values:

  • BUILT_IN

  • BUILT_SELF

delete_allowed

Boolean

Whether deletion is allowed

group_desc

String

Rule group description

group_name

String

Rule group name

id

String

Rule group ID

rule_names

String

Rule name

task_names

String

Scanning task name

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Message

Example Requests

Query sensitive data scanning rule groups.

GET /v1/{project_id}/sdg/server/scan/groups

Example Responses

Status code: 200

Request sent

{
  "total" : 20,
  "groups" : [ {
    "id" : "xxxxxxxxxxxx",
    "group_name" : "xxxx",
    "group_desc" : "xxxx",
    "category" : "private",
    "rule_names" : "xxxx",
    "task_names" : "xxxx",
    "delete_allowed" : false,
    "is_default" : false
  } ]
}

Status code: 400

Invalid request

{
  "error_code" : "dsc.40000011",
  "error_msg" : "Invalid parameter"
}

Status Codes

Status Code

Description

200

Request sent

400

Invalid request

Error Codes

See Error Codes.