Viewing the Rule List (To Be Discontinued)
Function
Query the scan rule list. The total number of scan rules and detailed information are returned. Pagination query is supported.
Calling Method
For details, see Calling APIs.
URI
GET /v1/{project_id}/sdg/server/scan/rules
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID, which is used to identify a specific project. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
offset |
No |
Integer |
Page number, which is used for pagination query. The default value is 0. |
|
limit |
No |
Integer |
Page size, which is used to limit the number of results returned on each page. The default value is 100. |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
rules |
Array of ResponseRule objects |
Rule list, which contains the details of each rule. |
|
total |
Integer |
Total number of rules. |
|
Parameter |
Type |
Description |
|---|---|---|
|
category |
String |
Rule category, which can be BUILT_IN (built-in rule) or BUILT_SELF (user-defined rule). |
|
delete_allowed |
Boolean |
Whether the rule can be deleted. |
|
group_names |
String |
Name of the rule group to which the rule belongs. |
|
id |
String |
Rule ID, which uniquely identifies a rule. |
|
logic_operator |
String |
Logical operator. The value can be AND, OR, or REGEX. |
|
min_match |
Integer |
Minimum matching times, which is used to determine the rule matching conditions. |
|
risk_level |
Integer |
Risk level, which indicates the risk level of the sensitive data identified by the rule. |
|
rule_content |
String |
Rule content, which depends on the rule type, such as keyword, regular expression, or natural language description. |
|
rule_desc |
String |
Rule description, which briefly describes the rule function. |
|
rule_name |
String |
Rule name, which is used to identify and manage rules. |
|
rule_type |
String |
Rule type, which can be KEYWORD (keyword), REGEX (regular expression), or NLP (natural language). |
|
selected |
Boolean |
Whether the rule can be selected or configured. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, which uniquely identifies an error type. |
|
error_msg |
String |
Error information, which describes the error details. |
Example Requests
Query the scan rule list (to be brought offline).
GET /v1/{project_id}/sdg/server/scan/rules
Example Responses
Status code: 200
The request is successful, and the scan rule list is returned.
{
"total" : 1,
"rules" : [ {
"category" : "BUILT_SELF",
"delete_allowed" : true,
"group_names" : "xxxx",
"id" : "xxxxxxxxxxxx",
"logic_operator" : "AND",
"min_match" : 1,
"risk_level" : 1,
"rule_content" : "xxxx",
"rule_desc" : "xxxx",
"rule_name" : "xxxx",
"rule_type" : "KEYWORD",
"selected" : true
} ]
}
Status code: 400
Invalid request. Incorrect parameter format or content.
{
"error_code" : "dsc.40000011",
"error_msg" : "Invalid parameter"
}
SDK Sample Code
The SDK sample code is as follows.
Java
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 |
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 ShowRulesSolution { 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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DscClient client = DscClient.newBuilder() .withCredential(auth) .withRegion(DscRegion.valueOf("<YOUR REGION>")) .build(); ShowRulesRequest request = new ShowRulesRequest(); try { ShowRulesResponse response = client.showRules(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()); } } } |
Python
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 |
# 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"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DscClient.new_builder() \ .with_credentials(credentials) \ .with_region(DscRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowRulesRequest() response = client.show_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dsc.NewDscClient( dsc.DscClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowRulesRequest{} response, err := client.ShowRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
More
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 |
The request is successful, and the scan rule list is returned. |
|
400 |
Invalid request. Incorrect parameter format or content. |
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