创建规则
功能介绍
创建规则
调用方法
请参见如何调用API。
URI
POST /v2/{domain_id}/rules/create
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
租户ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
是 |
String |
类型:Build,Gate,Deploy,Test,Normal |
name |
是 |
String |
规则名称 |
layout_content |
是 |
String |
布局内容 |
plugin_id |
否 |
String |
插件ID |
plugin_name |
否 |
String |
插件名称 |
plugin_version |
否 |
String |
插件版本号 |
content |
是 |
Array of RuleContent objects |
规则属性分组列表 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
group_name |
是 |
String |
分组名称 |
can_modify_when_inherit |
否 |
Boolean |
继承后的子策略是否可以修改阈值 |
properties |
是 |
Array of RuleProperty objects |
规则属性列表 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
status |
Boolean |
创建状态 |
rule_id |
String |
规则ID |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误信息 |
error_code |
String |
错误码 |
请求示例
POST https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/create { "name" : "新建规则-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" } ] } ] }
响应示例
状态码: 200
OK
{ "status" : true, "rule_id" : "2965ed53fe804115816b781ab20fef3c" }
SDK代码示例
SDK代码示例如下。
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 |
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(); 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("新建规则-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 |
# 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() 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="新建规则-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 |
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{} 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: "新建规则-20231020170337", Type: "Build", } response, err := client.CreateRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
错误码
请参见错误码。