DescribeHybridCloudClusterRules - Web Application Firewall

Cluster rules

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-waf:DescribeHybridCloudClusterRules

get

*All Resource

*

acs:ResourceGroupId

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the WAF instance. Note You can call the DescribeInstance operation to obtain the ID of the WAF instance.	waf_v3prepaid_public_cn-****
RuleType	string	Yes	The type of the rule. Valid value: pullin: traffic redirection	pullin
ClusterId	integer	Yes	The ID of the hybrid cloud cluster. Note This parameter is available only for hybrid cloud scenarios. You can call the DescribeHybridCloudClusters operation to obtain information about hybrid cloud clusters.	428
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
PageNumber	integer	No	The page number. Default value: 1.	1
RegionId	string	No	The region where the WAF instance resides. Valid values: cn-hangzhou: the Chinese mainland. ap-southeast-1: outside the Chinese mainland.	cn-hangzhou
ResourceManagerResourceGroupId	string	No	The ID of the resource group.	rg-acfm***q
RuleContent	string	No	The prefix of the rule value to match.	1.1.1.1
RuleMatchType	string	No	The matching logic. Valid values: exact: exact match regex: regular expression match	exact

Response elements

Element	Type	Description	Example
	object	The response data.
TotalCount	integer	The total number of cloud native mode entries returned.	10
RequestId	string	The ID of the request.	D7861F61-5B61-46CE-A47C-6B19160D5EB0
Data	array<object>	The response data.
	object	The compliance detection result.
ClusterId	integer	The ID of the hybrid cloud cluster.	1099
ClusterRuleResourceId	string	The resource ID of the cluster rule.	hdbc-clusterrule-*****khzre0ym0w
RuleConfig	string	The configuration of the traffic redirection rule: check_mode : the mode. Valid values: all: redirects all traffic. part: redirects a portion of traffic. type : the match type of the rule. Valid values: exact: exact match. regex: regular expression match. substance: the value of the rule.	{\"check_mode\": \"all\", \"type\": \"exact\", \"substance\": \"122\"}
RuleType	string	The type of the rule. Valid value: pullin: traffic redirection	pullin
Status	string	The status of the rule. Valid values: 1: enabled. 0: disabled.	1
Version	integer	The version number.	1

Examples

Success response

JSON format

{
  "TotalCount": 10,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "ClusterId": 1099,
      "ClusterRuleResourceId": "hdbc-clusterrule-*****khzre0ym0w",
      "RuleConfig": "{\\\"check_mode\\\": \\\"all\\\", \\\"type\\\": \\\"exact\\\", \\\"substance\\\": \\\"122\\\"}",
      "RuleType": "pullin",
      "Status": "1",
      "Version": 1
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.