Creating a Sensitive Data Scanning Task
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.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/sdg/scan/job
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
asset_ids |
Yes |
Array of strings |
Asset ID list |
cycle |
Yes |
String |
Scanning period, which can be DAY, WEEK, MONTH, or ONCE. Enumeration values:
|
name |
Yes |
String |
Scanning task name |
open |
No |
Boolean |
Whether to enable the task |
rule_group_ids |
Yes |
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
Parameter |
Type |
Description |
---|---|---|
msg |
String |
Returned message |
status |
String |
Return status, for example, '200', '400'. |
Status code: 400
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" }
SDK Sample Code
The SDK sample code is as follows.
Create a scan job named xxxx, select the xxxxxxxxxxxx rule group for it, and set it to Scan Once and Execute Immediately.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dsc.v1.region.DscRegion; import com.huaweicloud.sdk.dsc.v1.*; import com.huaweicloud.sdk.dsc.v1.model.*; import java.util.List; import java.util.ArrayList; public class AddScanJobSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); AddScanJobRequest request = new AddScanJobRequest(); ScanJobRequest body = new ScanJobRequest(); List<String> listbodyRuleGroupIds = new ArrayList<>(); listbodyRuleGroupIds.add("xxxx"); listbodyRuleGroupIds.add("xxxx"); List<String> listbodyAssetIds = new ArrayList<>(); listbodyAssetIds.add("xxxx"); listbodyAssetIds.add("xxxx"); body.withUseNlp(false); body.withTopicUrn("xxxxxxxxxxxx"); body.withTimeZone("8"); body.withStartTime(0L); body.withRuleGroupIds(listbodyRuleGroupIds); body.withOpen(true); body.withName("xxxx"); body.withCycle(ScanJobRequest.CycleEnum.fromValue("ONCE")); body.withAssetIds(listbodyAssetIds); request.withBody(body); try { AddScanJobResponse response = client.addScanJob(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Create a scan job named xxxx, select the xxxxxxxxxxxx rule group for it, and set it to Scan Once and Execute Immediately.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdsc.v1.region.dsc_region import DscRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdsc.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = AddScanJobRequest() listRuleGroupIdsbody = [ "xxxx", "xxxx" ] listAssetIdsbody = [ "xxxx", "xxxx" ] request.body = ScanJobRequest( use_nlp=False, topic_urn="xxxxxxxxxxxx", time_zone="8", start_time=0, rule_group_ids=listRuleGroupIdsbody, open=True, name="xxxx", cycle="ONCE", asset_ids=listAssetIdsbody ) response = client.add_scan_job(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Create a scan job named xxxx, select the xxxxxxxxxxxx rule group for it, and set it to Scan Once and Execute Immediately.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dsc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dsc/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AddScanJobRequest{} var listRuleGroupIdsbody = []string{ "xxxx", "xxxx", } var listAssetIdsbody = []string{ "xxxx", "xxxx", } useNlpScanJobRequest:= false topicUrnScanJobRequest:= "xxxxxxxxxxxx" timeZoneScanJobRequest:= "8" startTimeScanJobRequest:= int64(0) openScanJobRequest:= true request.Body = &model.ScanJobRequest{ UseNlp: &useNlpScanJobRequest, TopicUrn: &topicUrnScanJobRequest, TimeZone: &timeZoneScanJobRequest, StartTime: &startTimeScanJobRequest, RuleGroupIds: listRuleGroupIdsbody, Open: &openScanJobRequest, Name: "xxxx", Cycle: model.GetScanJobRequestCycleEnum().ONCE, AssetIds: listAssetIdsbody, } response, err := client.AddScanJob(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Request sent |
400 |
Invalid request |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot