更新时间:2025-08-19 GMT+08:00
分享

获取单条规则详情

功能介绍

获取单条规则详情

调用方法

请参见如何调用API

URI

GET /v2/{domain_id}/rules/{rule_id}/detail

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

租户ID。

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

rule_id

String

参数解释

规则ID,规则的唯一标识,通过分页获取规则列表接口获取,data.id即为规则ID。

约束限制

不涉及。

取值范围

32位字符,由数字和字母组成。

默认取值

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

id

String

参数解释

规则ID。

取值范围

32位字符,由数字和字母组成。

type

String

参数解释

规则类型。

取值范围

  • Build:构建。

  • Gate:代码检查。

  • Test:测试。

name

String

参数解释

规则名称。

取值范围

不涉及。

version

String

参数解释

规则版本。

取值范围

不涉及。

plugin_id

String

参数解释

扩展插件唯一ID。

取值范围

不涉及。

plugin_name

String

参数解释

扩展插件名称。

取值范围

不涉及。

plugin_version

String

参数解释

扩展插件版本号。

取值范围

不涉及。

creator

String

参数解释

规则创建人。

取值范围

不涉及。

create_time

String

参数解释

规则创建时间。

取值范围

不涉及。

updater

String

参数解释

规则最后更新人。

取值范围

不涉及。

update_time

String

参数解释

规则最后更新时间。

取值范围

不涉及。

content

Array of RuleContent objects

参数解释

规则详细属性。

取值范围

不涉及。

表4 RuleContent

参数

参数类型

描述

group_name

String

参数解释

分组名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

can_modify_when_inherit

Boolean

参数解释

继承后的子策略是否可以修改阈值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

properties

Array of RuleProperty objects

参数解释

规则属性列表。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

表5 RuleProperty

参数

参数类型

描述

key

String

参数解释

属性键。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

type

String

参数解释

类型。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

name

String

参数解释

展示名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

operator

String

参数解释

比较运算符。

约束限制

不涉及。

取值范围

  • ‘=’:等于。

  • ‘>’:大于。

  • ‘<’:小于。

  • ‘>=’:大于等于。

  • ‘<=’:小于等于。

  • ‘!=’:不等于。

  • ‘in’:包含其中。

  • ‘not in’:不被包含。

默认取值

不涉及。

value

String

参数解释

属性值。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

value_type

String

参数解释

数据类型。

约束限制

不涉及。

取值范围

  • float:数值型。

  • string:字符型。

默认取值

不涉及。

is_valid

Boolean

参数解释

属性是否启用。

约束限制

不涉及。

取值范围

  • true:启用。

  • false:未启用。

默认取值

false。

状态码:400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

error_msg

String

参数解释

错误描述。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

请求示例

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/rules/865b4c2d616b46ab890fff056a6f7e05/detail

响应示例

状态码:200

请求成功

{
  "id" : "865b4c2d616b46ab890fff056a6f7e05",
  "type" : "Build",
  "name" : "新建规则-20231020103003",
  "version" : "e2db2a63b3064252874b1b5a8571e2be",
  "plugin_id" : "official_devcloud_cloudBuild",
  "plugin_name" : "official_devcloud_cloudBuild",
  "plugin_version" : "0.0.15",
  "content" : [ {
    "group_name" : "MavenUnitTest",
    "can_modify_when_inherit" : true,
    "properties" : [ {
      "key" : "build.PassRatio",
      "type" : "judge",
      "name" : "PassRatio",
      "value_type" : "float",
      "value" : "0.1",
      "operator" : "="
    }, {
      "key" : "build.TotalCases",
      "type" : "judge",
      "name" : "TotalCases",
      "value_type" : "float",
      "value" : "0.1",
      "operator" : "="
    }, {
      "key" : "build.CoverageRatio",
      "type" : "judge",
      "name" : "CoverageRatio",
      "value_type" : "float",
      "value" : "0.1",
      "operator" : "="
    } ]
  } ],
  "creator" : "847a5317086c41798469d0868535943a",
  "create_time" : "2023-10-20T10:30:20",
  "updater" : "847a5317086c41798469d0868535943a",
  "update_time" : "2023-10-20T10:30:20"
}

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
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.*;


public class ShowRuleSolution {

    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();
        ShowRuleRequest request = new ShowRuleRequest();
        request.withDomainId("{domain_id}");
        request.withRuleId("{rule_id}");
        try {
            ShowRuleResponse response = client.showRule(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
# 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 = ShowRuleRequest()
        request.domain_id = "{domain_id}"
        request.rule_id = "{rule_id}"
        response = client.show_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
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.ShowRuleRequest{}
	request.DomainId = "{domain_id}"
	request.RuleId = "{rule_id}"
	response, err := client.ShowRule(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求成功

400

请求失败

401

认证失败

403

无权限

404

资源不存在

错误码

请参见错误码

相关文档