Querying Details About a Tenant-Level Open Source Governance Policy
Function
Querying Details About a Tenant-Level Open Source Governance Policy
URI
GET /v2/{domain_id}/tenant/open-source/rule-sets/{rule_set_id}/detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Indicates the tenant ID. |
rule_set_id |
Yes |
String |
Rule Set ID |
Request 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
Parameter |
Type |
Description |
---|---|---|
id |
String |
Policy ID. |
name |
String |
Policy Name |
level |
String |
Policy Level |
parent_id |
String |
Parent Policy ID |
version |
String |
Policy Versions |
is_valid |
Boolean |
Enable Configuration |
is_public |
Boolean |
Indicates whether the policy is a system-level policy. |
creator |
String |
Created By |
create_time |
String |
Created |
updater |
String |
User who updated the data |
update_time |
String |
Updated |
content |
OpenSourceRuleContent object |
Policy Rule Details |
Parameter |
Type |
Description |
---|---|---|
version_set |
VersionSetProperty object |
Open-source dependencies |
security |
SecurityProperty object |
Vulnerability |
license |
LicenseProperty object |
License |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Enable Configuration |
rules |
Array of VersionSetRule objects |
Rule list. |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Health Check |
ecosystem |
String |
Dependency Degree |
package_name |
String |
Package name |
package_version |
String |
Package Version |
description |
String |
Rules |
predicate |
String |
Comparison Rule |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Enable Configuration |
rules |
SecurityRule object |
Rule Details |
Parameter |
Type |
Description |
---|---|---|
severity |
severity object |
Severity |
cve |
cve object |
Vulnerability ID |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Enable Configuration |
values |
Array of strings |
Severity |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Enable Configuration |
values |
Array of strings |
Vulnerability ID |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Health Check |
rules |
Array of rules objects |
Rule list. |
Parameter |
Type |
Description |
---|---|---|
values |
Array of strings |
License Details |
predicate |
String |
Comparison Rule |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error Message |
error_code |
String |
Error code. |
Example Requests
GET https://{endpoint}/v2/ce8df55870164338a72d7e828a966a2a/tenant/open-source/rule-sets/5bd5bee0865242fcaa545371c2081a65/detail
Example Responses
Status code: 200
OK
{
"id" : "5bd5bee0865242fcaa545371c2081a65",
"name" : "Creating an Open Source Governance Policy CC22",
"level" : "tenant",
"version" : "5fc812e9f5414f58859c3393319dd2ae",
"is_valid" : false,
"is_public" : false,
"creator" : "6417ffac26074726bdd074a766ce7852",
"create_time" : "2023-09-19T11:00:33",
"updater" : "2f46b8efe31342be936443643f50b4af",
"update_time" : "2023-09-28T09:57:06",
"content" : {
"version_set" : {
"enable" : true,
"rules" : [ ]
},
"security" : {
"enable" : true,
"rules" : {
"severity" : {
"enable" : false,
"values" : [ ]
},
"cve" : {
"enable" : false,
"values" : [ "" ]
}
}
},
"license" : {
"enable" : true,
"rules" : [ {
"predicate" : "contain",
"values" : [ ]
} ]
}
}
}
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.