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	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value consists of 32 characters, including digits and letters. Default value: N/A
rule_id	Yes	String	Definition: Rule ID, which is the unique identifier of a rule. Obtain the rule ID by calling the API for obtaining rules by page. data.id indicates the rule ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A

Request Parameters

**Table 2** Request header 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 for . Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition: Rule ID. Value range: The value consists of 32 characters, including digits and letters.
type	String	Definition: Rule type. Value range: Build. Gate: code check. Test.
name	String	Definition: Rule name. Value range: N/A
is_valid	Boolean	Definition: Whether the rule is valid. Range: true: The rule is valid. false: The rule is invalid.
version	String	Definition: Rule version. Value range: N/A
plugin_id	String	Definition: Unique ID of the extension. Range: N/A
plugin_name	String	Definition: Extension name. Value range: N/A
plugin_version	String	Definition: Extension version number. Value range: N/A
creator	String	Definition: Rule creator. Value range: N/A
create_time	String	Definition: Time when a rule was created. Value range: N/A
updater	String	Definition: User who last updated the rule. Value range: N/A
update_time	String	Definition: Time when the rule was last updated. Value range: N/A
content	Array of RuleContent objects	Definition: Rule attributes. Value range: N/A

**Table 4** RuleContent
Parameter	Type	Description
group_name	String	Definition: Group name. Constraints: N/A Value range: N/A Default value: N/A
can_modify_when_inherit	Boolean	Definition: Whether the threshold of the inherited sub-policy can be modified. Constraints: N/A Range: true: The threshold can be modified. false: The threshold cannot be modified. Default value: N/A
editable	Boolean	Definition: Editable or not. Constraints: N/A Range: true: editable. false: not editable. Default value: N/A
properties	Array of RuleProperty objects	Definition: Rule attributes. Constraints: N/A Value range: N/A Default value: N/A

**Table 5** RuleProperty
Parameter	Type	Description
key	String	Definition: Attribute key. Constraints: N/A Value range: N/A Default value: N/A
type	String	Definition: Rule type. Constraints: N/A Range: Build: build. Gate: code check. Test: test. Default value: N/A
name	String	Definition: Displayed name. Constraints: N/A Value range: N/A Default value: N/A
operator	String	Definition: Comparison operator. Constraints: N/A Range: =: equal to. >: greater than. <: less than. >=: greater than or equal to. <=: less than or equal to. !=: not equal to. in: included. not in: not included. Default value: N/A
value	String	Definition: Attribute value. Constraints: N/A Value range: N/A Default value: N/A
value_type	String	Definition: Data type. Constraints: N/A Value range: float: numeric type string: string type. Default value: N/A
is_valid	Boolean	Definition: Attribute enabled or not. Constraints: N/A Value range: true: enabled. false: disabled. Default value: false.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Constraints: N/A Value range: N/A Default value: N/A
error_msg	String	Definition: Error message. Constraints: N/A Value range: N/A Default value: N/A

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"
}