Querying Details About a Specified Aggregated Rule
Function
This API is used to query details about a specified aggregated rule.
Calling Method
For details, see Calling APIs.
URI
POST /v1/resource-manager/domains/{domain_id}/aggregators/aggregate-data/policy-assignment/detail
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 |
Yes |
String |
Specifies the source account ID. Minimum: 1 Maximum: 36 |
policy_assignment_id |
Yes |
String |
Specifies the rule ID. Maximum: 36 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
policy_assignment_type |
String |
Specifies the rule type, which can be builtin or custom. |
id |
String |
Specifies the rule ID. |
name |
String |
Specifies the rule name. |
description |
String |
Specifies the rule description. |
policy_filter |
PolicyFilterDefinition object |
Specifies the policy filter of a rule. |
period |
String |
Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours. |
state |
String |
Specifies the rule status. |
created |
String |
Specifies the time when the rule was added. |
updated |
String |
Specifies the time when the rule was modified. |
policy_definition_id |
String |
Specifies the ID of the policy used by the rule. |
custom_policy |
CustomPolicy object |
Specifies the custom rule. |
parameters |
Map<String,PolicyParameterValue> |
Specifies the rule parameters. |
tags |
Array of ResourceTag objects |
Tags |
created_by |
String |
Specifies the person who created the rule. |
target_type |
String |
Execution method of remediation. |
target_id |
String |
The ID of a remediation object. |
Parameter |
Type |
Description |
---|---|---|
region_id |
String |
Specifies the region ID. Maximum: 128 |
resource_provider |
String |
Specifies the cloud service name. Maximum: 128 |
resource_type |
String |
Specifies the resource type. Maximum: 128 |
resource_id |
String |
Specifies the resource ID. Maximum: 512 |
tag_key |
String |
Specifies the tag key. Maximum: 128 |
tag_value |
String |
Specifies the tag value. Maximum: 256 |
Parameter |
Type |
Description |
---|---|---|
function_urn |
String |
Specifies the URN of a custom function. Maximum: 1024 |
auth_type |
String |
Specifies how function is called by a custom rule. |
auth_value |
Map<String,Object> |
Specifies the parameter value for invoking a function by a custom rule. |
Parameter |
Type |
Description |
---|---|---|
value |
Object |
Specifies the value of the rule parameter. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. A tag key can contain up to 128 Unicode characters and must complay with the character set specifications in section 3.1. Minimum: 1 Maximum: 128 |
value |
String |
Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2. Minimum: 0 Maximum: 255 |
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 details about a specified aggregated rule
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" }
Example Responses
Status code: 200
Operation succeeded.
{ "policy_assignment_type" : "builtin", "id" : "64104fff86952b3af614cabb", "name" : "required-tag-check", "description" : "A resource is non-compliant if it does not have a specified tag.", "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 Sample Code
The SDK sample code is as follows.
Querying details about a specified aggregated rule
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()); } } } |
Querying details about a specified aggregated rule
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) |
Querying details about a specified aggregated rule
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) } } |
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