Querying Compliance Results of Aggregated Resources
Function
This API is used to query resources evaluated by a specified aggregated rule and their compliance statuses. A compliance result contains the evaluated resource and its compliance status.
Calling Method
For details, see Calling APIs.
URI
POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-states/compliance-details
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies tags. Maximum: 36 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Specifies the maximum number of records to return. Minimum: 1 Maximum: 200 Default: 200 |
marker |
No |
String |
Specifies the pagination parameter. Minimum: 4 Maximum: 400 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Security-Token |
No |
String |
Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
aggregator_id |
Yes |
String |
Specifies the resource aggregator ID. Minimum: 1 Maximum: 256 |
account_id |
No |
String |
Specifies the source account ID. Minimum: 1 Maximum: 36 |
compliance_state |
No |
String |
Specifies the compliance result. |
policy_assignment_name |
No |
String |
Specifies the rule name. Maximum: 64 |
resource_name |
No |
String |
Specifies the resource name. Minimum: 1 Maximum: 256 |
resource_id |
No |
String |
Specifies the resource ID. Minimum: 1 Maximum: 512 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
policy_states |
Array of PolicyState objects |
Specifies the return value of querying the compliance result. |
page_info |
PageInfo object |
Specifies the pagination object. |
Parameter |
Type |
Description |
---|---|---|
domain_id |
String |
Specifies the user ID. |
region_id |
String |
Specifies the ID of the region the resource belongs to. |
resource_id |
String |
Specifies the resource ID. |
resource_name |
String |
Specifies the resource name. |
resource_provider |
String |
Specifies the cloud service name. |
resource_type |
String |
Specifies the resource type. |
trigger_type |
String |
Specifies the trigger type. The value can be resource or period. |
compliance_state |
String |
Specifies the compliance status. |
policy_assignment_id |
String |
Specifies the rule ID. |
policy_assignment_name |
String |
Specifies the rule name. |
policy_definition_id |
String |
Specifies the policy ID. |
evaluation_time |
String |
Specifies the evaluation time of compliance status. |
Parameter |
Type |
Description |
---|---|---|
current_count |
Integer |
Specifies the resource quantity on the current page. Minimum: 0 Maximum: 200 |
next_marker |
String |
Specifies the marker value of the next page. Minimum: 4 Maximum: 400 |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
Querying compliance results of aggregated resources
POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-states/compliance-details { "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f", "account_id" : "39f4a9434e0c4bf3806e5aff54adea39", "policy_assignment_name" : "required-tag-check" }
Example Responses
Status code: 200
Operation succeeded.
{ "policy_states" : [ { "domain_id" : "39f4a9434e0c4bf3806e5aff54adea39", "region_id" : "region1", "resource_id" : "04d5a1a31c314ebba8c73daa66c6cd12", "resource_name" : "group1", "resource_provider" : "iam", "resource_type" : "groups", "trigger_type" : "resource", "compliance_state" : "NonCompliant", "policy_assignment_id" : "64104fff86952b3af614cabb", "policy_assignment_name" : "required-tag-check", "policy_definition_id" : "5fa9f89b6eed194ccb2c04db", "evaluation_time" : 1678790655196 }, { "domain_id" : "39f4a9434e0c4bf3806e5aff54adea39", "region_id" : "global", "resource_id" : "06c113bd3edf40eabc552d29a775b9cf", "resource_name" : "group2", "resource_provider" : "iam", "resource_type" : "groups", "trigger_type" : "resource", "compliance_state" : "NonCompliant", "policy_assignment_id" : "64104fff86952b3af614cabb", "policy_assignment_name" : "required-tag-check", "policy_definition_id" : "5fa9f89b6eed194ccb2c04db", "evaluation_time" : 1678790655197 } ], "page_info" : { "current_count" : 2, "next_marker" : "CAESIDdjYTM0NDc4MzBiZDQ5YzliNjMwYTk5NjgwZWFmOTBmGgQ-0aw3" } }
SDK Sample Code
The SDK sample code is as follows.
Querying compliance results of aggregated resources
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.config.v1.region.ConfigRegion; import com.huaweicloud.sdk.config.v1.*; import com.huaweicloud.sdk.config.v1.model.*; public class ShowAggregateComplianceDetailsByPolicyAssignmentSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); ConfigClient client = ConfigClient.newBuilder() .withCredential(auth) .withRegion(ConfigRegion.valueOf("<YOUR REGION>")) .build(); ShowAggregateComplianceDetailsByPolicyAssignmentRequest request = new ShowAggregateComplianceDetailsByPolicyAssignmentRequest(); request.withLimit(<limit>); request.withMarker("<marker>"); AggregateComplianceDetailRequest body = new AggregateComplianceDetailRequest(); body.withPolicyAssignmentName("required-tag-check"); body.withAccountId("39f4a9434e0c4bf3806e5aff54adea39"); body.withAggregatorId("7ca3447830bd49c9b630a99680eaf90f"); request.withBody(body); try { ShowAggregateComplianceDetailsByPolicyAssignmentResponse response = client.showAggregateComplianceDetailsByPolicyAssignment(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Querying compliance results of aggregated resources
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkconfig.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = ConfigClient.new_builder() \ .with_credentials(credentials) \ .with_region(ConfigRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowAggregateComplianceDetailsByPolicyAssignmentRequest() request.limit = <limit> request.marker = "<marker>" request.body = AggregateComplianceDetailRequest( policy_assignment_name="required-tag-check", account_id="39f4a9434e0c4bf3806e5aff54adea39", aggregator_id="7ca3447830bd49c9b630a99680eaf90f" ) response = client.show_aggregate_compliance_details_by_policy_assignment(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Querying compliance results of aggregated resources
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := config.NewConfigClient( config.ConfigClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowAggregateComplianceDetailsByPolicyAssignmentRequest{} limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest policyAssignmentNameAggregateComplianceDetailRequest:= "required-tag-check" accountIdAggregateComplianceDetailRequest:= "39f4a9434e0c4bf3806e5aff54adea39" request.Body = &model.AggregateComplianceDetailRequest{ PolicyAssignmentName: &policyAssignmentNameAggregateComplianceDetailRequest, AccountId: &accountIdAggregateComplianceDetailRequest, AggregatorId: "7ca3447830bd49c9b630a99680eaf90f", } response, err := client.ShowAggregateComplianceDetailsByPolicyAssignment(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Operation succeeded. |
400 |
Invalid parameters. |
403 |
Authentication failed or you do not have the operation permissions. |
500 |
Server error. |
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