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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Specifies tags. Maximum: 36

Request Parameters

**Table 2** Request header 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.

**Table 3** Request body parameters
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

**Table 4** Response body parameters
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.

**Table 5** PolicyFilterDefinition
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

**Table 6** CustomPolicy
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.

**Table 7** PolicyParameterValue
Parameter	Type	Description
value	Object	Specifies the value of the rule parameter.

**Table 8** ResourceTag
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

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Specifies the error code.
error_msg	String	Specifies the error message.

Status code: 500

**Table 11** Response body parameters
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",
  "created_by" : "customer"
}