查询指定聚合合规规则详情
功能介绍
查询指定聚合合规规则的详情。
调用方法
请参见如何调用API。
URI
POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignment/detail
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
aggregator_id |
是 |
String |
资源聚合器ID 最小长度:1 最大长度:256 |
account_id |
是 |
String |
源账号ID 最小长度:1 最大长度:36 |
policy_assignment_id |
是 |
String |
合规规则ID 最大长度:36 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
policy_assignment_type |
String |
规则类型,包括预定义合规规则(builtin)和用户自定义合规规则(custom) |
id |
String |
规则ID。 |
name |
String |
规则名称。 |
description |
String |
规则描述。 |
policy_filter |
PolicyFilterDefinition object |
规则过滤器。 |
period |
String |
周期值,可选值:One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours |
state |
String |
规则状态。 |
created |
String |
规则创建时间。 |
updated |
String |
规则更新时间。 |
policy_definition_id |
String |
规则的策略ID。 |
custom_policy |
CustomPolicy object |
自定义合规规则 |
parameters |
Map<String,PolicyParameterValue> |
规则参数。 |
tags |
Array of ResourceTag objects |
标签列表 |
created_by |
String |
规则的创建者 |
target_type |
String |
合规规则修正方式。 |
target_id |
String |
修正执行的目标id。 |
参数 |
参数类型 |
描述 |
---|---|---|
region_id |
String |
区域ID。 最大长度:128 |
resource_provider |
String |
云服务名称。 最大长度:128 |
resource_type |
String |
资源类型。 最大长度:128 |
resource_id |
String |
资源ID。 最大长度:512 |
tag_key |
String |
标签键。 最大长度:128 |
tag_value |
String |
标签值。 最大长度:256 |
参数 |
参数类型 |
描述 |
---|---|---|
function_urn |
String |
自定义函数的URN 最大长度:1024 |
auth_type |
String |
自定义合规规则调用function方式 |
auth_value |
Map<String,Object> |
自定义合规规则调用function方式的参数值 |
参数 |
参数类型 |
描述 |
---|---|---|
key |
String |
键。最大长度128个unicode字符。 key符合3.1 KEY字符集规范。 最小长度:1 最大长度:128 |
value |
String |
值。每个值最大长度255个unicode字符。value符合3.2 VALUE字符集规范。 最小长度:0 最大长度:255 |
状态码: 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-assignment/detail { "aggregator_id" : "7ca3447830bd49c9b630a99680eaf90f", "account_id" : "39f4a9434e0c4bf3806e5aff54adea39", "policy_assignment_id" : "64104fff86952b3af614cabb" }
响应示例
状态码: 200
操作成功。
{ "policy_assignment_type" : "builtin", "id" : "64104fff86952b3af614cabb", "name" : "required-tag-check", "description" : "指定一个标签,不具有此标签的资源,视为“不合规”", "policy_filter" : { "region_id" : null, "resource_provider" : null, "resource_type" : null, "resource_id" : null, "tag_key" : null, "tag_value" : null }, "period" : null, "state" : "Enabled", "created" : "2023-04-03T06:40:12.846Z", "updated" : "2023-04-03T06:40:12.846Z", "policy_definition_id" : "5fa9f89b6eed194ccb2c04db", "tags" : [ { "key" : "tagkey", "value" : "tagValue" } ], "created_by" : "custom" }
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 |
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 ShowAggregatePolicyAssignmentDetailSolution { 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(); ShowAggregatePolicyAssignmentDetailRequest request = new ShowAggregatePolicyAssignmentDetailRequest(); AggregatePolicyAssignmentDetailRequest body = new AggregatePolicyAssignmentDetailRequest(); body.withPolicyAssignmentId("64104fff86952b3af614cabb"); body.withAccountId("39f4a9434e0c4bf3806e5aff54adea39"); body.withAggregatorId("7ca3447830bd49c9b630a99680eaf90f"); request.withBody(body); try { ShowAggregatePolicyAssignmentDetailResponse response = client.showAggregatePolicyAssignmentDetail(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 |
# 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 = ShowAggregatePolicyAssignmentDetailRequest() request.body = AggregatePolicyAssignmentDetailRequest( policy_assignment_id="64104fff86952b3af614cabb", account_id="39f4a9434e0c4bf3806e5aff54adea39", aggregator_id="7ca3447830bd49c9b630a99680eaf90f" ) response = client.show_aggregate_policy_assignment_detail(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 |
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.ShowAggregatePolicyAssignmentDetailRequest{} request.Body = &model.AggregatePolicyAssignmentDetailRequest{ PolicyAssignmentId: "64104fff86952b3af614cabb", AccountId: "39f4a9434e0c4bf3806e5aff54adea39", AggregatorId: "7ca3447830bd49c9b630a99680eaf90f", } response, err := client.ShowAggregatePolicyAssignmentDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作成功。 |
400 |
输入参数不合法。 |
403 |
用户认证失败或无操作权限。 |
500 |
服务器内部错误。 |
错误码
请参见错误码。