Obtaining Details of Open-Source Governance Policies
Function
This API is used to obtain details of open-source governance policies.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{domain_id}/tenant/open-source/rule-sets/{rule_set_id}/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
rule_set_id |
Yes |
String |
Definition: Policy ID. Constraints: N/A Value range: N/A Default value: N/A |
domain_id |
Yes |
String |
Definition: Tenant ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cloud_project_id |
No |
String |
Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
Request 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 forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Rule template instance ID. Value range: The value consists of 32 characters, including digits and letters. |
name |
String |
Definition: Rule template instance name. Value range: N/A |
type |
String |
Definition: Rule template type. Value range: N/A |
version |
String |
Definition: Rule template policy. Value range: N/A |
creator |
String |
Definition: Policy creator. Value range: N/A |
create_time |
String |
Definition: Policy creation time. Value range: N/A |
updater |
String |
Definition: User who last updated the policy. Value range: N/A |
update_time |
String |
Definition: Time when the policy was last updated. Value range: N/A |
is_valid |
Boolean |
Definition: Whether the policy takes effect. Value range:
|
rule_instances |
Array of RuleInstance objects |
Definition: Rule instance set. Value range: N/A |
level |
String |
Definition: Effective level of a rule instance. Value range: N/A |
is_public |
Boolean |
Definition: Whether the rule instance is system-level. Value range:
|
is_legacy |
Boolean |
Definition: Whether the rule instance data is from version 1.0. Value range:
|
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Rule instance ID. Value range: The value consists of 32 characters, including digits and letters. |
type |
String |
Definition: Rule type. Value range: N/A |
name |
String |
Definition: Rule name. Value range: N/A |
version |
String |
Definition: Rule version. Value range: N/A |
plugin_id |
String |
Definition: Extension ID. Value range: N/A |
plugin_name |
String |
Definition: Extension name. Value range: N/A |
plugin_version |
String |
Definition: Extension version number. Value range: N/A |
is_valid |
Boolean |
Definition: Whether the rule takes effect. Value range:
|
editable |
Boolean |
Definition: Whether the rule can be edited. Value range:
|
content |
Array of RuleInstanceContent objects |
Definition: Rule instance set. Value range: N/A |
parent |
RuleSet object |
Definition: Parent instance attribute. Value range: N/A. |
Parameter |
Type |
Description |
---|---|---|
group_name |
String |
Definition: Group name. Value range: N/A |
editable |
Boolean |
Definition: Editable or not. Value range: N/A |
type |
String |
Definition: Group type. Value range: N/A |
can_modify_when_inherit |
Boolean |
Definition: Whether the threshold of the inherited sub-policy can be modified. Value range:
|
properties |
Array of RuleInstanceProperty objects |
Definition: Rule attributes. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Definition: Rule attribute key. Value range: N/A |
type |
String |
Definition: Rule type. Value range: N/A |
name |
String |
Definition: Displayed name. Value range: N/A |
operator |
String |
Definition: Comparison operator. Value range: N/A |
value |
String |
Definition: Attribute value. Value range: N/A |
value_type |
String |
Definition: Data type. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Rule template instance ID. Value range: N/A |
name |
String |
Definition: Rule template instance name. Value range: N/A |
type |
String |
Definition: Rule instance type. Value range: N/A |
version |
String |
Definition: Rule instance version. Value range: N/A |
operator |
String |
Definition: Latest operator of the rule instance. Value range: N/A |
operate_time |
Long |
Definition: Time when the rule was last operated. Value range: N/A |
is_valid |
Boolean |
Definition: Whether the rule instance takes effect. Value range:
|
level |
String |
Definition: Effective level of a rule instance. Value range: N/A |
is_public |
Boolean |
Definition: Whether the rule instance is system-level. Value range:
|
is_legacy |
Boolean |
Definition: Whether the rule instance data is from version 1.0. Value range:
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: N/A |
Example Requests
None
Example Responses
Status code: 200
OK
{ "id" : "6cb18ee5ca1c48caa335706e0e5ee288", "name" : "Creating 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 auto-created 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 gate", "can_modify_when_inherit" : false, "properties" : [ { "key" : "apitest", "type" : "judge", "name" : "API Test Pass Rate", "value_type" : "float", "value" : "0.5", "operator" : ">=" } ] } ] } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot