Creating a Sensitive Data Scanning Task

Updated on 2023-12-07 GMT+08:00

View PDF

Function

This API is used to create a sensitive data scanning task with parameters such as task name, scanning mode, scanning period, scanning rule group, and scanning time.

URI

POST /v1/{project_id}/sdg/scan/job

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
asset_ids	No	Array of strings	Asset ID list
cycle	No	String	Scanning period, which can be DAY, WEEK, MONTH, or ONCE. Enumeration values: ONCE DAY WEEK MONTH
name	No	String	Scanning task name
open	No	Boolean	Whether to enable the task
rule_group_ids	No	Array of strings	Rule group ID list
start_time	No	Long	Start time of a scanning task
time_zone	No	String	Time zone
topic_urn	No	String	Unique resource identifier of a topic
use_nlp	No	Boolean	Whether to use NLP

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
msg	String	Returned message
status	String	Return status, for example, '200', '400'.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Message

Example Requests

Create a scan job named xxxx, select the xxxxxxxxxxxx rule group for it, and set it to Scan Once and Execute Immediately.

POST /v1/{project_id}/sdg/scan/job

{
  "asset_ids" : [ "xxxx", "xxxx" ],
  "cycle" : "ONCE",
  "name" : "xxxx",
  "open" : true,
  "rule_group_ids" : [ "xxxx", "xxxx" ],
  "start_time" : 0,
  "time_zone" : 8,
  "topic_urn" : "xxxxxxxxxxxx",
  "use_nlp" : false
}

Example Responses

Status code: 200

Request sent

{
  "msg" : "xxxx",
  "status" : "RESPONSE_SUCCESS"
}

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.

Parent topic: Sensitive Data Discovery

Previous topic: Deleting a Sensitive Data Scanning Rule Group

Next topic: Deleting a Sensitive Data Scanning Task

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel