Customizing a Rule Set
Function
This API is used to combine rules as required.
Calling Method
For details, see Calling APIs.
URI
POST /v2/ruleset
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Media type and encoding format. |
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
template_name |
Yes |
String |
New rule set name. |
language |
Yes |
String |
Rule set language. |
is_default |
Yes |
String |
0: with base rule set; 1: without base rule set. |
rule_ids |
Yes |
String |
ID of the newly enabled rule. |
uncheck_ids |
No |
String |
ID of the new closed rule. |
template_id |
No |
String |
Rule set ID. |
custom_attributes |
No |
Array of CustomAttributes objects |
Customized rule parameter. Modifying rule thresholds is supported. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
attribute |
No |
String |
Configuration item attribute. Severity indicates the issue severity. |
rules |
No |
Array of CustomAttributesRule objects |
Rule details. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
rule_id |
No |
String |
Rule ID. |
value |
No |
String |
Attribute issue level. 0: critical; 1: major; 2: minor; 3: suggestion. |
rule_config_list |
No |
Array of RuleConfig objects |
Rule threshold details. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
No |
Integer |
Rule configuration ID. |
rule_id |
No |
Integer |
Rule ID. |
default_value |
No |
String |
Default value. |
option_value |
No |
String |
Current. |
option_key |
No |
String |
Key of the current rule configuration item. |
option_name |
No |
String |
Name of the current rule configuration item. |
template_id |
No |
String |
Rule set ID. |
description |
No |
String |
Description. |
Response Parameters
Status code: 201
Parameter |
Type |
Description |
---|---|---|
template_id |
String |
Rule set ID. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
Customize a rule set: Set template name to test_cpp and language to cpp. The project ID and template ID corresponding to the rule set are displayed based on the site requirements.
POST https://{endpoint}/v2/ruleset { "project_id" : "24b97exxxxxxxxfb912625b14cxxxxxx", "template_id" : "da303dxxxxxxxxaca60dbcc2e2xxxxxx", "template_name" : "test_cpp", "language" : "cpp", "is_default" : "1", "rule_ids" : "8139,8138", "uncheck_ids" : "1101,1102" }
Example Responses
Status code: 201
Request succeeded!
{ "template_id" : "c53417a4804f45eba9c11991131c9e79" }
Status code: 400
Bad Request
{ "error_code" : "CC.00000000", "error_msg" : "Network busy. Try again later." }
Status code: 401
Unauthorized
{ "error_code" : "CC.00000003", "error_msg" : "Authentication information expired." }
SDK Sample Code
The SDK sample code is as follows.
Customize a rule set: Set template name to test_cpp and language to cpp. The project ID and template ID corresponding to the rule set are displayed based on the site requirements.
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 |
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.codecheck.v2.region.CodeCheckRegion; import com.huaweicloud.sdk.codecheck.v2.*; import com.huaweicloud.sdk.codecheck.v2.model.*; public class CreateRulesetSolution { 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); CodeCheckClient client = CodeCheckClient.newBuilder() .withCredential(auth) .withRegion(CodeCheckRegion.valueOf("<YOUR REGION>")) .build(); CreateRulesetRequest request = new CreateRulesetRequest(); Ruleset body = new Ruleset(); body.withTemplateId("da303dxxxxxxxxaca60dbcc2e2xxxxxx"); body.withUncheckIds("1101,1102"); body.withRuleIds("8139,8138"); body.withIsDefault("1"); body.withLanguage("cpp"); body.withTemplateName("test_cpp"); body.withProjectId("24b97exxxxxxxxfb912625b14cxxxxxx"); request.withBody(body); try { CreateRulesetResponse response = client.createRuleset(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()); } } } |
Customize a rule set: Set template name to test_cpp and language to cpp. The project ID and template ID corresponding to the rule set are displayed based on the site requirements.
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodecheck.v2.region.codecheck_region import CodeCheckRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodecheck.v2 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 = CodeCheckClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeCheckRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateRulesetRequest() request.body = Ruleset( template_id="da303dxxxxxxxxaca60dbcc2e2xxxxxx", uncheck_ids="1101,1102", rule_ids="8139,8138", is_default="1", language="cpp", template_name="test_cpp", project_id="24b97exxxxxxxxfb912625b14cxxxxxx" ) response = client.create_ruleset(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Customize a rule set: Set template name to test_cpp and language to cpp. The project ID and template ID corresponding to the rule set are displayed based on the site requirements.
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codecheck "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codecheck/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codecheck/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codecheck/v2/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 := codecheck.NewCodeCheckClient( codecheck.CodeCheckClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateRulesetRequest{} templateIdRuleset:= "da303dxxxxxxxxaca60dbcc2e2xxxxxx" uncheckIdsRuleset:= "1101,1102" request.Body = &model.Ruleset{ TemplateId: &templateIdRuleset, UncheckIds: &uncheckIdsRuleset, RuleIds: "8139,8138", IsDefault: "1", Language: "cpp", TemplateName: "test_cpp", ProjectId: "24b97exxxxxxxxfb912625b14cxxxxxx", } response, err := client.CreateRuleset(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 |
---|---|
201 |
Request succeeded! |
400 |
Bad Request |
401 |
Unauthorized |
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