Listing Non-Compliant Resources
Function
This API is used to list all non-compliant resources in an organization.
URI
GET https://{endpoint}/v1/governance/control-violations
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
account_id |
No |
String |
ID of an enrolled account. |
organizational_unit_id |
No |
String |
ID of a registered OU. |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
control_violations |
Array of ControlViolation objects |
Compliance of a governance policy. |
Parameter |
Type |
Description |
---|---|---|
account_id |
String |
ID of an enrolled account. |
account_name |
String |
Name of an enrolled account. |
display_name |
String |
Display name of a governance policy. |
name |
String |
Name of a governance policy. |
control_id |
String |
Governance policy ID. |
parent_organizational_unit_id |
String |
ID of a registered parent OU. |
parent_organizational_unit_name |
String |
Name of a registered parent OU. |
region |
String |
Region name. |
resource |
String |
Non-compliant resources of a governance policy. |
resource_name |
String |
Name of a non-compliant resource. |
resource_type |
String |
Type of non-compliant resources of a governance policy. |
service |
String |
Cloud service name. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
request_id |
String |
Unique ID of the request. |
encoded_authorization_message |
String |
Encrypted error message. |
details |
Array of ForbiddenErrorDetail objects |
Error message indicating no permissions for cross-service invoking. |
Example Requests
Listing all non-compliant resources in an organization
GET https://{endpoint}/v1/governance/control-violations
Example Responses
Status code: 200
Request succeeded.
{ "control_violations" : [ { "account_id" : "string", "account_name" : "string", "display_name" : "string", "name" : "string", "control_id" : "string", "parent_organizational_unit_id" : "string", "parent_organizational_unit_name" : "string", "region" : "string", "resource" : "string", "resource_name" : "string", "resource_type" : "string", "service" : "string" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
403 |
No permissions. |
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