Creating a Rule
Function
This API is used to create a rule.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{domain_id}/rules/create
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Definition: Type of the rule to be created. Constraints: N/A Value range:
Default value: N/A |
name |
Yes |
String |
Definition: Rule name. Constraints: N/A Value range: N/A Default value: N/A |
layout_content |
Yes |
String |
Definition: Layout content. Constraints: N/A Value range: N/A Default value: N/A |
plugin_id |
No |
String |
Definition: Extension ID. Obtain the ID by calling the API for querying the extension details. unique_id indicates extension ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
plugin_name |
No |
String |
Definition: Extension name. Constraints: Enter only letters, digits, hyphens (-), and underscores (_). Value range: 1 to 50 characters. Default value: N/A |
plugin_version |
No |
String |
Definition: Extension version number. Constraints: The value must be in the format of x.xx.xx, where x is a number ranging from 0 to 99. xx indicates the number following the dot (.). Each xx can be a one-digit or two-digit number. Value range: N/A Default value: N/A |
content |
Yes |
Array of RuleContent objects |
Definition: Rule attribute group list. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
group_name |
Yes |
String |
Definition: Group name. Constraints: N/A Value range: N/A Default value: N/A |
can_modify_when_inherit |
No |
Boolean |
Definition: Whether the threshold of the inherited sub-policy can be modified. Constraints: N/A Value range: N/A Default value: N/A |
properties |
Yes |
Array of RuleProperty objects |
Definition: Rule attributes. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
String |
Definition: Attribute key. Constraints: N/A Value range: N/A Default value: N/A |
type |
Yes |
String |
Definition: Type. Constraints: N/A Value range: N/A Default value: N/A |
name |
Yes |
String |
Definition: Displayed name. Constraints: N/A Value range: N/A Default value: N/A |
operator |
No |
String |
Definition: Comparison operator. Constraints: N/A Value range:
Default value: N/A |
value |
Yes |
String |
Definition: Attribute value. Constraints: N/A Value range: N/A Default value: N/A |
value_type |
Yes |
String |
Definition: Data type. Constraints: N/A Value range:
Default value: N/A |
is_valid |
No |
Boolean |
Definition: Attribute enabled or not. Constraints: N/A Value range:
Default value: false. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
status |
Boolean |
Definition: Creation status. Constraints: N/A Value range: N/A Default value: N/A |
rule_id |
String |
Definition: Rule ID. Constraints: N/A Value range: N/A Default value: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: N/A |
Example Requests
POST https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/create { "name" : "Creating a Rule - 20231020170337", "type" : "Build", "plugin_id" : "official_devcloud_cloudBuild", "plugin_name" : "official_devcloud_cloudBuild", "plugin_version" : "0.0.15", "layout_content" : "layout_content", "content" : [ { "group_name" : "MavenUnitTest", "properties" : [ { "key" : "build.PassRatio", "name" : "PassRatio", "type" : "judge", "operator" : "=", "value_type" : "float", "value" : "0.1" }, { "key" : "build.TotalCases", "name" : "TotalCases", "type" : "judge", "operator" : "=", "value_type" : "float", "value" : "0.1" }, { "key" : "build.CoverageRatio", "name" : "CoverageRatio", "type" : "judge", "operator" : "=", "value_type" : "float", "value" : "0.1" } ] } ] }
Example Responses
Status code: 200
OK
{ "status" : true, "rule_id" : "2965ed53fe804115816b781ab20fef3c" }
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
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.codeartspipeline.v2.region.CodeArtsPipelineRegion; import com.huaweicloud.sdk.codeartspipeline.v2.*; import com.huaweicloud.sdk.codeartspipeline.v2.model.*; import java.util.List; import java.util.ArrayList; public class CreateRuleSolution { 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); CodeArtsPipelineClient client = CodeArtsPipelineClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsPipelineRegion.valueOf("<YOUR REGION>")) .build(); CreateRuleRequest request = new CreateRuleRequest(); request.withDomainId("{domain_id}"); CreateRuleReq body = new CreateRuleReq(); List<RuleProperty> listContentProperties = new ArrayList<>(); listContentProperties.add( new RuleProperty() .withKey("build.PassRatio") .withType("judge") .withName("PassRatio") .withOperator("=") .withValue("0.1") .withValueType("float") ); listContentProperties.add( new RuleProperty() .withKey("build.TotalCases") .withType("judge") .withName("TotalCases") .withOperator("=") .withValue("0.1") .withValueType("float") ); listContentProperties.add( new RuleProperty() .withKey("build.CoverageRatio") .withType("judge") .withName("CoverageRatio") .withOperator("=") .withValue("0.1") .withValueType("float") ); List<RuleContent> listbodyContent = new ArrayList<>(); listbodyContent.add( new RuleContent() .withGroupName("MavenUnitTest") .withProperties(listContentProperties) ); body.withContent(listbodyContent); body.withPluginVersion("0.0.15"); body.withPluginName("official_devcloud_cloudBuild"); body.withPluginId("official_devcloud_cloudBuild"); body.withLayoutContent("layout_content"); body.withName("Creating a Rule - 20231020170337"); body.withType("Build"); request.withBody(body); try { CreateRuleResponse response = client.createRule(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 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 65 66 67 68 69 70 71 72 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartspipeline.v2.region.codeartspipeline_region import CodeArtsPipelineRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartspipeline.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 = CodeArtsPipelineClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsPipelineRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateRuleRequest() request.domain_id = "{domain_id}" listPropertiesContent = [ RuleProperty( key="build.PassRatio", type="judge", name="PassRatio", operator="=", value="0.1", value_type="float" ), RuleProperty( key="build.TotalCases", type="judge", name="TotalCases", operator="=", value="0.1", value_type="float" ), RuleProperty( key="build.CoverageRatio", type="judge", name="CoverageRatio", operator="=", value="0.1", value_type="float" ) ] listContentbody = [ RuleContent( group_name="MavenUnitTest", properties=listPropertiesContent ) ] request.body = CreateRuleReq( content=listContentbody, plugin_version="0.0.15", plugin_name="official_devcloud_cloudBuild", plugin_id="official_devcloud_cloudBuild", layout_content="layout_content", name="Creating a Rule - 20231020170337", type="Build" ) response = client.create_rule(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 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartspipeline "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartspipeline/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 := codeartspipeline.NewCodeArtsPipelineClient( codeartspipeline.CodeArtsPipelineClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateRuleRequest{} request.DomainId = "{domain_id}" operatorProperties:= "=" operatorProperties1:= "=" operatorProperties2:= "=" var listPropertiesContent = []model.RuleProperty{ { Key: "build.PassRatio", Type: "judge", Name: "PassRatio", Operator: &operatorProperties, Value: "0.1", ValueType: "float", }, { Key: "build.TotalCases", Type: "judge", Name: "TotalCases", Operator: &operatorProperties1, Value: "0.1", ValueType: "float", }, { Key: "build.CoverageRatio", Type: "judge", Name: "CoverageRatio", Operator: &operatorProperties2, Value: "0.1", ValueType: "float", }, } var listContentbody = []model.RuleContent{ { GroupName: "MavenUnitTest", Properties: listPropertiesContent, }, } pluginVersionCreateRuleReq:= "0.0.15" pluginNameCreateRuleReq:= "official_devcloud_cloudBuild" pluginIdCreateRuleReq:= "official_devcloud_cloudBuild" request.Body = &model.CreateRuleReq{ Content: listContentbody, PluginVersion: &pluginVersionCreateRuleReq, PluginName: &pluginNameCreateRuleReq, PluginId: &pluginIdCreateRuleReq, LayoutContent: "layout_content", Name: "Creating a Rule - 20231020170337", Type: "Build", } response, err := client.CreateRule(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 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
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