Querying the Result of an Identification Task
Function
This API is used to query the result of a specified identification task.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/sdg/scan/job/{job_id}/results
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
job_id |
Yes |
String |
Task ID |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
No |
Integer |
Page number |
limit |
No |
Integer |
Page size |
type |
No |
String |
Asset type Enumeration values:
|
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
Task ID |
job_name |
String |
Task name |
type |
String |
Asset type |
db_scan_result |
DbScanResult object |
Result of identification tasks for databases |
obs_scan_result |
ObsScanResult object |
Result of the identification task for OBS |
es_scan_result |
EsScanResult object |
Result of the identification task for Elasticsearch |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of results |
db_scan_results |
Array of DbScanResultInfo objects |
Result list of identification tasks for databases |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Task ID |
db_name |
String |
Database name |
table_id |
String |
Table ID |
table_name |
String |
Table name |
risk_level |
Integer |
Risk level |
sensitive_data_type |
Array of strings |
Matched rules |
match_info |
Array of DbMatchInfo objects |
Matched rules of table columns |
Parameter |
Type |
Description |
---|---|---|
column_name |
String |
Column name |
rule_name |
String |
Name of the matched rule |
rule_id |
String |
ID of the matched rule |
rule_risk_level |
Integer |
Risk level of the matched rule |
column_line |
Array of longs |
Columns of risk data |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of results |
db_scan_results |
Array of ObsScanResultInfo objects |
Result list of the identification task for OBS |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Task ID |
bucket_id |
String |
OBS bucket ID |
bucket_name |
String |
OBS bucket name |
file_path |
String |
Directory |
file_name |
String |
File name |
md5 |
String |
File MD5 |
risk_level |
Integer |
Risk level |
sensitive_data_type |
Array of strings |
Sensitive data types |
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of results |
db_scan_results |
Array of EsScanResultInfo objects |
Result list of the identification task for Elasticsearch |
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
Task ID |
index_name |
String |
Index name |
type_id |
String |
Type ID |
type_name |
String |
Type name |
risk_level |
Integer |
Risk level |
sensitive_data_type |
Array of strings |
Sensitive data type |
match_info |
Array of EsMatchInfo objects |
Details of matched rules |
Parameter |
Type |
Description |
---|---|---|
field_name |
String |
Data field name |
rule_name |
String |
Rule name |
rule_id |
String |
Rule ID |
rule_risk_level |
Integer |
Risk level of the matched rule |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error Message |
Example Requests
Querying the Result of an Identification Task
GET /v1/{project_id}/sdg/scan/job/{job_id}/results
Example Responses
Status code: 200
OK
{ "job_id" : "xxxxxx", "job_name" : "xxxxxx", "type" : "DATABASE", "db_scan_result" : { "total" : 1, "db_scan_results" : [ { "task_id" : "xxxxxx", "db_name" : "xxxxxx", "table_id" : "xxxxxx", "table_name" : "student", "risk_level" : 6, "sensitive_data_type" : [ "xxxxxx", "xxxxxx" ], "match_info" : [ { "column_name" : "phone", "rule_name" : "xxxxxx", "rule_id" : "xxxxxx", "rule_risk_level" : 6, "column_line" : [ 1, 3 ] }, { "column_name" : "email", "rule_name" : "xxxxxx", "rule_id" : "xxxxxx", "rule_risk_level" : 1, "column_line" : [ 1, 3 ] } ] } ] }, "obs_scan_result" : null, "es_scan_result" : null }
Status code: 400
Invalid request
{ "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
SDK Sample Code
The SDK sample code is as follows.
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 |
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.*; public class ShowScanJobResultsSolution { 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(); ShowScanJobResultsRequest request = new ShowScanJobResultsRequest(); request.withOffset(<offset>); request.withLimit(<limit>); request.withType(ShowScanJobResultsRequest.TypeEnum.fromValue("<type>")); try { ShowScanJobResultsResponse response = client.showScanJobResults(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()); } } } |
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 |
# 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 = ShowScanJobResultsRequest() request.offset = <offset> request.limit = <limit> request.type = "<type>" response = client.show_scan_job_results(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.ShowScanJobResultsRequest{} offsetRequest:= int32(<offset>) request.Offset = &offsetRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest typeRequest:= model.GetShowScanJobResultsRequestTypeEnum().<TYPE> request.Type = &typeRequest response, err := client.ShowScanJobResults(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 |
OK |
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