Querying the Compliance Summary of One or More Source Accounts in an Aggregator
Function
This API is used to query the number of compliant and non-compliant rules of one or more accounts in the aggregator.
Calling Method
For details, see Calling APIs.
URI
POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-states/compliance-summary
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Specifies tags. Maximum: 36 |
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 |
group_by_key |
No |
String |
Specifies the key DOMAIN used to group resource counts. Minimum: 1 Maximum: 16 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
results |
Array of AggregatePolicyComplianceSummaryResult objects |
Specifies the compliance summary results. |
Parameter |
Type |
Description |
---|---|---|
resource_details |
PolicyComplianceSummaryUnit object |
Specifies the compliance summary details. |
assignment_details |
PolicyComplianceSummaryUnit object |
Specifies the compliance summary details. |
group_name |
String |
Specifies the group name |
group_account_name |
String |
Account name |
Parameter |
Type |
Description |
---|---|---|
compliant_count |
Integer |
Specifies the number of compliant resources. |
non_compliant_count |
Integer |
Specifies the number of non-compliant resources. |
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 the compliance summary of one or more source accounts in an aggregator
POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-states/compliance-summary { "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f", "group_by_key" : "DOMAIN" }
Example Responses
Status code: 200
Operation succeeded.
{ "results" : [ { "resource_details" : { "compliant_count" : null, "non_compliant_count" : 70 }, "assignment_details" : { "compliant_count" : 0, "non_compliant_count" : 1 }, "group_name" : "39f4a9434e0c4bf3806e5aff54adea39", "group_account_name" : "demo1" }, { "resource_details" : { "compliant_count" : null, "non_compliant_count" : 0 }, "assignment_details" : { "compliant_count" : 1, "non_compliant_count" : 0 }, "group_name" : "789d4ac10eda4d9b8e090f5c2b1e4459", "group_account_name" : "demo2" } ] }
SDK Sample Code
The SDK sample code is as follows.
Querying the compliance summary of one or more source accounts in an aggregator
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 |
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 ShowAggregatePolicyStateComplianceSummarySolution { 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(); ShowAggregatePolicyStateComplianceSummaryRequest request = new ShowAggregatePolicyStateComplianceSummaryRequest(); AggregatePolicyStatesRequest body = new AggregatePolicyStatesRequest(); body.withGroupByKey("DOMAIN"); body.withAggregatorId("7ca3447830bd49c9b630a99680eaf90f"); request.withBody(body); try { ShowAggregatePolicyStateComplianceSummaryResponse response = client.showAggregatePolicyStateComplianceSummary(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 the compliance summary of one or more source accounts in an aggregator
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 |
# 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 = ShowAggregatePolicyStateComplianceSummaryRequest() request.body = AggregatePolicyStatesRequest( group_by_key="DOMAIN", aggregator_id="7ca3447830bd49c9b630a99680eaf90f" ) response = client.show_aggregate_policy_state_compliance_summary(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 the compliance summary of one or more source accounts in an aggregator
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 |
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.ShowAggregatePolicyStateComplianceSummaryRequest{} groupByKeyAggregatePolicyStatesRequest:= "DOMAIN" request.Body = &model.AggregatePolicyStatesRequest{ GroupByKey: &groupByKeyAggregatePolicyStatesRequest, AggregatorId: "7ca3447830bd49c9b630a99680eaf90f", } response, err := client.ShowAggregatePolicyStateComplianceSummary(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