查询指定聚合合规规则的资源评估结果详情
功能介绍
查询指定聚合合规规则的资源评估结果详情。包含评估的资源,以及每个资源是否符合规则。
调用方法
请参见如何调用API。
URI
POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-states/compliance-details
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 最大长度:36 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
最大的返回数量。 最小值:1 最大值:200 缺省值:200 |
marker |
否 |
String |
分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。 最小长度:4 最大长度:400 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
aggregator_id |
是 |
String |
资源聚合器ID 最小长度:1 最大长度:256 |
account_id |
否 |
String |
源账号ID 最小长度:1 最大长度:36 |
compliance_state |
否 |
String |
合规结果。 |
policy_assignment_name |
否 |
String |
合规规则名称 最大长度:64 |
resource_name |
否 |
String |
资源名称 最小长度:1 最大长度:256 |
resource_id |
否 |
String |
资源ID 最小长度:1 最大长度:512 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
policy_states |
Array of PolicyState objects |
合规结果查询返回值 |
page_info |
PageInfo object |
分页对象。 |
参数 |
参数类型 |
描述 |
---|---|---|
domain_id |
String |
用户ID。 |
region_id |
String |
资源区域ID。 |
resource_id |
String |
资源ID。 |
resource_name |
String |
资源名称。 |
resource_provider |
String |
云服务名称。 |
resource_type |
String |
资源类型。 |
trigger_type |
String |
触发器类型,可选值为"resource"和"period"。 |
compliance_state |
String |
合规结果。 |
policy_assignment_id |
String |
规则ID。 |
policy_assignment_name |
String |
规则名称。 |
policy_definition_id |
String |
策略ID。 |
evaluation_time |
String |
合规状态评估时间。 |
参数 |
参数类型 |
描述 |
---|---|---|
current_count |
Integer |
当前页的资源数量。 最小值:0 最大值:200 |
next_marker |
String |
下一页的marker。 最小长度:4 最大长度:400 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
状态码: 403
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
请求示例
查询指定聚合合规规则的资源评估结果详情
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" }
响应示例
状态码: 200
操作成功。
{ "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代码示例
SDK代码示例如下。
查询指定聚合合规规则的资源评估结果详情
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()); } } } |
查询指定聚合合规规则的资源评估结果详情
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) |
查询指定聚合合规规则的资源评估结果详情
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) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
输入参数不合法。 |
403 |
用户认证失败或无操作权限。 |
500 |
服务器内部错误。 |
错误码
请参见错误码。