Help Center/ CodeArts Pipeline/ API Reference/ API/ Rule Management/ Obtaining Details About a Single Rule
Updated on 2025-03-25 GMT+08:00

Obtaining Details About a Single Rule

Function

This API is used to query details about a single rule.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Tenant ID.

rule_id

Yes

String

Rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

User token.

It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints:

None.

Value range:

None.

Default value:

None.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Rule ID.

type

String

Rule type.

name

String

Rule name.

version

String

Rule version.

layout_content

String

Layout content.

plugin_id

String

Extension ID.

plugin_name

String

Extension name.

plugin_version

String

Extension version.

creator

String

Creator.

create_time

String

Creation time.

updater

String

Updater.

update_time

String

Update time.

content

Array of RuleContent objects

Rule attribute list.

Table 4 RuleContent

Parameter

Type

Description

group_name

String

Group name.

can_modify_when_inherit

Boolean

Whether thresholds of an inherited policy can be modified.

properties

Array of RuleProperty objects

Rule attribute list.

Table 5 RuleProperty

Parameter

Type

Description

key

String

Attribute key.

type

String

Type.

name

String

Display name.

operator

String

Comparison operators.

value

String

Attribute value.

value_type

String

Data type.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

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

Example Responses

Status code: 200

Request succeeded.

{
  "id" : "865b4c2d616b46ab890fff056a6f7e05",
  "type" : "Build",
  "name" : "New Rule-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 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
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)
    }
}

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

Request succeeded.

400

Request failed.

401

Authentication failed.

403

No permission.

404

Resource not found.

Error Codes

See Error Codes.