Obtaining Rule Set Details

Updated on 2023-11-28 GMT+08:00

View PDF

Function

URI

GET /v2/{domain_id}/tenant/rule-sets/{rule_set_id}/detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
rule_set_id	Yes	String	Rule Set ID
domain_id	Yes	String	Indicates the tenant ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cloud_project_id	No	String	Project ID

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Rule Template Instance ID
name	String	Rule Template Instance Name
type	String	Type
version	String	Version
creator	String	Created By
create_time	String	Created
updater	String	User who performs the last update.
update_time	String	Last update time.
is_valid	Boolean	Effective
rule_instances	Array of RuleInstance objects	Rule Instance Set

**Table 5** RuleInstance
Parameter	Type	Description
id	String	Rule Instance ID
type	String	Rule Type ID
name	String	Rule Name
version	String	Rule version.
plugin_id	String	Plug-in ID
plugin_name	String	Plug-in
plugin_version	String	Add-on version.
is_valid	Boolean	Effective
editable	Boolean	Whether the pipeline is editable
content	Array of RuleInstanceContent objects	Rule Attribute List
parent	RuleSet object	Brief information about the parent rule instance template

**Table 6** RuleInstanceContent
Parameter	Type	Description
group_name	String	Group Name
type	String	Group type
can_modify_when_inherit	Boolean	Can the Threshold of an Inherited Subpolicy Be Modified?
properties	Array of RuleInstanceProperty objects	Rule Attribute List

**Table 7** RuleInstanceProperty
Parameter	Type	Description
key	String	Attribute Key
type	String	Type
name	String	Display name
operator	String	Comparison Operators
value	String	Property value.
value_type	String	Data Type

**Table 8** RuleSet
Parameter	Type	Description
id	String	Rule Template Instance ID
name	String	Rule Template Instance Name
type	String	Type
version	String	Version
operator	String	Latest Operator
operate_time	Long	Last Operation Time
is_valid	Boolean	Effective
level	String	Tenant-level and project-level
is_public	Boolean	System Level

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_msg	String	Error Message
error_code	String	Error code.

Example Requests

GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/rule-sets/6cb18ee5ca1c48caa335706e0e5ee288/detail?cloud_project_id=

Example Responses

Status code: 200

{
  "id" : "6cb18ee5ca1c48caa335706e0e5ee288",
  "name" : "Create a tenant-level policy.",
  "version" : "c0ca09cfda8a426bbdb8df4c34c4831e",
  "is_valid" : true,
  "creator" : "847a5317086c41798469d0868535943a",
  "create_time" : "2023-09-25T19:32:14",
  "updater" : "847a5317086c41798469d0868535943a",
  "update_time" : "2023-10-20T17:12:41",
  "rule_instances" : [ {
    "id" : "80cfcff078074b8aa7951d7b67b3137b",
    "type" : "Gate",
    "name" : "API automatic creation rule dyEnd",
    "is_valid" : true,
    "version" : "8128ca663cdc4cea9a6dc05e53ae0a55",
    "plugin_id" : "official_devcloud_apiTest",
    "plugin_name" : "official_devcloud_apiTest",
    "plugin_version" : "0.0.6",
    "content" : [ {
      "group_name" : "API test pass rate access control",
      "can_modify_when_inherit" : false,
      "properties" : [ {
        "key" : "apitest",
        "type" : "judge",
        "name" : "API test pass rate",
        "value_type" : "float",
        "value" : "0.5",
        "operator" : ">="
      } ]
    } ]
  } ]
}