Listing Non-Compliant Resources

Function

This API is used to list all non-compliant resources in an organization.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
rgc:controlViolation:list	List	-	-	-	-

URI

GET /v1/governance/control-violations

**Table 1** Query Parameters
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

**Table 2** Response body parameters
Parameter	Type	Description
control_violations	Array of ControlViolation objects	Compliance of a governance policy.

**Table 3** ControlViolation
Parameter	Type	Description
account_id	String	ID 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

**Table 4** Response body parameters
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.

**Table 5** ForbiddenErrorDetail
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

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